Home > @firebase/firestore > lite > startAt

startAt() function

Creates a QueryConstraint that modifies the result set to start at the provided document (inclusive). The starting position is relative to the order of the query. The document must contain all of the fields provided in the orderBy of this query.

Signature:

export declare function startAt(snapshot: DocumentSnapshot<unknown>): QueryConstraint;

Parameters

Parameter	Type	Description
snapshot	DocumentSnapshot<unknown>	The snapshot of the document to start at.

Returns:

QueryConstraint

A QueryConstraint to pass to query().