@roar-firebase-functions/core

@roar-firebase-functions/core / FirestoreFetchDocumentParams

Interface: FirestoreFetchDocumentParams

Defined in: packages/core/src/types/firestore/params/base.params.ts:46

Params for fetching a document from a specific DocumentReference in Firestore. FirestoreFetchDocumentParams

Extends

Properties

docRef

docRef: DocumentReference

Defined in: packages/core/src/types/firestore/params/base.params.ts:47

The document reference to fetch.

filters?

optional filters: BaseFilter[]

Defined in: packages/core/src/repositories/base/base.repository.interface.ts:15

Optional array of filters to apply to the query.

Inherited from

FirestoreGetParams.filters

id?

optional id: string

Defined in: packages/core/src/repositories/base/base.repository.interface.ts:14

Optional ID for specific entity retrieval.

Inherited from

FirestoreGetParams.id

limit?

optional limit: number

Defined in: packages/core/src/repositories/base/base.repository.interface.ts:17

Optional limit on the number of results.

Inherited from

FirestoreGetParams.limit

select?

optional select: string | FieldPath

Defined in: packages/core/src/types/firestore/params/base.params.ts:27

Optional field or path to select from the document.

Inherited from

FirestoreGetParams.select

transaction?

optional transaction: Transaction

Defined in: packages/core/src/types/firestore/params/base.params.ts:26

Optional transaction instance for atomic operations.

Inherited from

FirestoreGetParams.transaction