Class CollectionReference<T>

A reference to a Firestore collection. Extends Query to provide query methods.

Type Parameters

T = DocumentData

Hierarchy (View Summary)

Query<T>
- CollectionReference

Index

Constructors

Properties

Methods

add count doc endAt endBefore get limit limitToLast offset orderBy select startAfter startAt where

Constructors

constructor

new CollectionReference<T = DocumentData>(
firestore: FirestoreClientInterface,
path: string,
): CollectionReference<T>
Type Parameters
- T = DocumentData
Parameters
- firestore: FirestoreClientInterface
- path: string
Returns CollectionReference<T>
Overrides Query.constructor
- Defined in references.ts:151

Properties

`Readonly`id

id: string

`Readonly`path

path: string

Methods

add

add(data: T): Promise<DocumentReference<T>>
Add a new document with an auto-generated ID.
Parameters
- data: T
Returns Promise<DocumentReference<T>>
- Defined in references.ts:173

count

count(): Promise<AggregateQuerySnapshot>
Returns a count of the documents matching the query.

Returns Promise<AggregateQuerySnapshot>
Inherited from Query.count
- Defined in query.ts:361

doc

doc(documentId?: string): DocumentReference<T>
Get a document reference in this collection. If no ID is provided, a random one will be generated.
Parameters
- OptionaldocumentId: string
Returns DocumentReference<T>
- Defined in references.ts:162

endAt

endAt(...values: unknown[]): Query<T>
Creates a new query ending at the provided values (inclusive).
Parameters
- ...values: unknown[]
Returns Query<T>
Inherited from Query.endAt
- Defined in query.ts:297

endBefore

endBefore(...values: unknown[]): Query<T>
Creates a new query ending before the provided values (exclusive).
Parameters
- ...values: unknown[]
Returns Query<T>
Inherited from Query.endBefore
- Defined in query.ts:307

get

get(): Promise<QuerySnapshot<T>>
Executes the query and returns the results.

Returns Promise<QuerySnapshot<T>>
Inherited from Query.get
- Defined in query.ts:335

limit

limit(count: number): Query<T>
Creates a new query that returns only the first matching documents.
Parameters
- count: number
Returns Query<T>
Inherited from Query.limit
- Defined in query.ts:231

limitToLast

limitToLast(count: number): Query<T>
Creates a new query that returns only the last matching documents. Must be used with at least one orderBy clause.
Parameters
- count: number
Returns Query<T>
Inherited from Query.limitToLast
- Defined in query.ts:246

offset

offset(count: number): Query<T>
Creates a new query that skips the first matching documents.
Parameters
- count: number
Returns Query<T>
Inherited from Query.offset
- Defined in query.ts:260

orderBy

orderBy(fieldPath: string, directionStr?: OrderByDirection): Query<T>
Creates a new query with an additional ordering.
Parameters
- fieldPath: string
- directionStr: OrderByDirection = "asc"
Returns Query<T>
Inherited from Query.orderBy
- Defined in query.ts:209

select

select(...fields: string[]): Query<T>
Creates a new query that returns only specific fields.
Parameters
- ...fields: string[]
Returns Query<T>
Inherited from Query.select
- Defined in query.ts:321

startAfter

startAfter(...values: unknown[]): Query<T>
Creates a new query starting after the provided values (exclusive).
Parameters
- ...values: unknown[]
Returns Query<T>
Inherited from Query.startAfter
- Defined in query.ts:287

startAt

startAt(...values: unknown[]): Query<T>
Creates a new query starting at the provided values (inclusive).
Parameters
- ...values: unknown[]
Returns Query<T>
Inherited from Query.startAt
- Defined in query.ts:277

where

where(fieldPath: string, opStr: WhereFilterOp, value: unknown): Query<T>
Creates a new query with an additional filter.
Parameters
- fieldPath: string
- opStr: WhereFilterOp
- value: unknown
Returns Query<T>
Inherited from Query.where
- Defined in query.ts:187