Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

collection

Gets a CollectionReference instance that refers to the collection at the specified absolute path.

function collection(

firestore: Firestore,

path: string,

...pathSegments: string[],

): CollectionReference<DocumentData, DocumentData>;

function collection<AppModelType, DbModelType extends DocumentData>(

reference: CollectionReference<AppModelType, DbModelType>,

path: string,

...pathSegments: string[],

): CollectionReference<DocumentData, DocumentData>;

function collection<AppModelType, DbModelType extends DocumentData>(

reference: DocumentReference<AppModelType, DbModelType>,

path: string,

...pathSegments: string[],

): CollectionReference<DocumentData, DocumentData>;

collection(firestore: Firestore, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>

Gets a CollectionReference instance that refers to the collection at the specified absolute path.

§Parameters

firestore: Firestore

A reference to the root Firestore instance.

path: string

A slash-separated path to a collection.

...pathSegments: string[] optional

Additional path segments to apply relative to the first argument.

§Return Type

CollectionReference<DocumentData, DocumentData>

The CollectionReference instance.

collection<AppModelType, DbModelType extends DocumentData>(reference: CollectionReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>

Gets a CollectionReference instance that refers to a subcollection of reference at the specified relative path.

§Type Parameters

AppModelType

DbModelType extends DocumentData

§Parameters

reference: CollectionReference<AppModelType, DbModelType>

A reference to a collection.

path: string

A slash-separated path to a collection.

...pathSegments: string[] optional

Additional path segments to apply relative to the first argument.

§Return Type

CollectionReference<DocumentData, DocumentData>

The CollectionReference instance.

collection<AppModelType, DbModelType extends DocumentData>(reference: DocumentReference<AppModelType, DbModelType>, path: string, ...pathSegments: string[]): CollectionReference<DocumentData, DocumentData>

Gets a CollectionReference instance that refers to a subcollection of reference at the specified relative path.

§Type Parameters

AppModelType

DbModelType extends DocumentData

§Parameters

reference: DocumentReference<AppModelType, DbModelType>

A reference to a Firestore document.

path: string

A slash-separated path to a collection.

...pathSegments: string[] optional

Additional path segments that will be applied relative to the first argument.

§Return Type

CollectionReference<DocumentData, DocumentData>

The CollectionReference instance.