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

startAt

Creates a QueryStartAtConstraint 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.

function startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint;
function startAt(...fieldValues: unknown[]): QueryStartAtConstraint;
§
startAt<AppModelType, DbModelType extends DocumentData>(snapshot: DocumentSnapshot<AppModelType, DbModelType>): QueryStartAtConstraint
[src]

Creates a QueryStartAtConstraint 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.

§Type Parameters

§
AppModelType
[src]
§
DbModelType extends DocumentData
[src]

§Parameters

§
snapshot: DocumentSnapshot<AppModelType, DbModelType>
[src]
  • The snapshot of the document to start at.
§
startAt(...fieldValues: unknown[]): QueryStartAtConstraint
[src]

Creates a QueryStartAtConstraint that modifies the result set to start 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.

§Parameters

§
...fieldValues: unknown[] optional
[src]
  • The field values to start this query at, in order of the query's order by.