CollectionReference

The collection's identifier.

id: string;

A reference to the containing DocumentReference if this is a subcollection. If this isn't a subcollection, the reference is null.

parent: DocumentReference | null;

A string representing the path of the referenced collection (relative to the root of the database).

path: string;

Add a new document to this collection with the specified data, assigning it a document ID automatically.

add(data: { [key: string]: value }): Promise<DocumentReference>;

Get a DocumentReference for the document within the collection at the specified path. If no path is specified, an automatically-generated unique ID will be used for the returned DocumentReference.

doc(documentPath?: undefined | string): DocumentReference;

Creates and returns a new Query that ends at the provided document (inclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

endAt(snapshot: DocumentSnapshot): Query;

Creates and returns a new Query that ends at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

endAt(fieldValues: any[]): Query;

Creates and returns a new Query that ends before the provided document (exclusive). The end position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

endBefore(snapshot: DocumentSnapshot): Query;

Creates and returns a new Query that ends before the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

endBefore(fieldValues: any[]): Query;

Executes the query and returns the results as a QuerySnapshot.

get(options?: GetOptions): Promise<QuerySnapshot>;

Returns true if this Query is equal to the provided one.

isEqual(other: Query): boolean;

Creates and returns a new Query where the results are limited to the specified number of documents.

limit(limit: number): Query;

Creates and returns a new Query where the results are limited to the specified number of documents starting from the last document. The order is dependent on the second parameter for the orderBy method. If desc is used, the order is reversed. orderBy method call is required when calling limitToLast.

limitToLast(limitToLast: number): Query;

Attaches a listener for QuerySnapshot events.

onSnapshot(observer: { complete: undefined | () => void, error: undefined | (error: Error) => void, next: undefined | (snapshot: QuerySnapshot) => void }): () => void;

Attaches a listener for QuerySnapshot events with snapshot listener options.

onSnapshot(options: SnapshotListenOptions, observer: { complete: undefined | () => void, error: undefined | (error: Error) => void, next: undefined | (snapshot: QuerySnapshot) => void }): () => void;

Attaches a listener for QuerySnapshot events.

onSnapshot(onNext: (snapshot: QuerySnapshot) => void, onError?: undefined | (error: Error) => void, onCompletion?: undefined | () => void): () => void;

Attaches a listener for QuerySnapshot events with snapshot listener options.

onSnapshot(options: SnapshotListenOptions, onNext: (snapshot: QuerySnapshot) => void, onError?: undefined | (error: Error) => void, onCompletion?: undefined | () => void): () => void;

Creates and returns a new Query that's additionally sorted by the specified field, optionally in descending order instead of ascending.

orderBy(fieldPath: string | FieldPath, directionStr?: "asc" | "desc"): Query;

Creates and returns a new Query that starts after the provided document (exclusive). The start position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

startAfter(snapshot: DocumentSnapshot): Query;

Creates and returns a new Query that starts after the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

startAfter(fieldValues: any[]): Query;

Creates and returns a new Query that starts at the provided document (inclusive). The start position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

startAt(snapshot: DocumentSnapshot): Query;

Creates and returns a new Query that starts at the provided fields relative to the order of the query. The order of the field values must match the order of the order by clauses of the query.

startAt(fieldValues: any[]): Query;

Creates and returns a new Query with the additional filter that documents must contain the specified field and the value should satisfy the relation constraint provided.

where(fieldPath: string | FieldPath, opStr: WhereFilterOp, value: any): Query;