Class QueryDocumentSnapshot<AppModelType, DbModelType>

Type Parameters

AppModelType = DocumentData
DbModelType extends DocumentData = DocumentData

Hierarchy (View Summary)

DocumentSnapshot<AppModelType, DbModelType>
- QueryDocumentSnapshot

Index

Accessors

Constructors

Methods

data exists get

Properties

Accessors

id

get id(): string
Returns string
Inherited from DocumentSnapshot.id
- Defined in types/firestore.ts:452

ref

get ref(): DocumentReference<AppModelType, DbModelType>
Returns DocumentReference<AppModelType, DbModelType>
Inherited from DocumentSnapshot.ref
- Defined in types/firestore.ts:453

Constructors

constructor

new QueryDocumentSnapshot<
AppModelType = DocumentData,
DbModelType extends DocumentData = DocumentData,
>(): QueryDocumentSnapshot<AppModelType, DbModelType>
Type Parameters
- AppModelType = DocumentData
- DbModelType extends DocumentData = DocumentData
Returns QueryDocumentSnapshot<AppModelType, DbModelType>
Inherited from DocumentSnapshot.constructor

Methods

data

data(options?: SnapshotOptions): AppModelType
Parameters
- Optionaloptions: SnapshotOptions
Returns AppModelType
Overrides DocumentSnapshot.data
- Defined in types/firestore.ts:460

exists

exists(): this is QueryDocumentSnapshot<AppModelType, DbModelType>
Returns this is QueryDocumentSnapshot<AppModelType, DbModelType>
Inherited from DocumentSnapshot.exists
- Defined in types/firestore.ts:449

get

get(fieldPath: string | FieldPath, options?: SnapshotOptions): any
Parameters
- fieldPath: string | FieldPath
- Optionaloptions: SnapshotOptions
Returns any
Inherited from DocumentSnapshot.get
- Defined in types/firestore.ts:451

Properties

`Readonly`metadata

metadata: SnapshotMetadata