Class CollectionReference<AppModelType, DbModelType>

Type Parameters

AppModelType = DocumentData
DbModelType extends DocumentData = DocumentData

Hierarchy (View Summary)

Query<AppModelType, DbModelType>
- CollectionReference

Index

Constructors

Methods

Properties

converter firestore id parent path type

Constructors

constructor

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

Methods

withConverter

withConverter(converter: null): CollectionReference<DocumentData, DocumentData>
Parameters
- converter: null
Returns CollectionReference<DocumentData, DocumentData>
Overrides Query.withConverter
- Defined in types/firestore.ts:354
withConverter<
    NewAppModelType,
    NewDbModelType extends DocumentData = DocumentData,
>(
    converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>,
): CollectionReference<NewAppModelType, NewDbModelType>
Type Parameters
- NewAppModelType
- NewDbModelType extends DocumentData = DocumentData
Parameters
- converter: FirestoreDataConverter<NewAppModelType, NewDbModelType>
Returns CollectionReference<NewAppModelType, NewDbModelType>
Overrides Query.withConverter
- Defined in types/firestore.ts:355

Properties

`Readonly`converter

converter: FirestoreDataConverter<AppModelType, DbModelType> | null

`Readonly`firestore

firestore: Firestore

id

id: string

parent

parent: DocumentReference<DocumentData, DocumentData> | null

path

path: string

`Readonly`type

type: "collection"