Function 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.

    Returns

    A QueryStartAtConstraint to pass to query().

    Type Parameters

    • AppModelType

    • DbModelType extends DocumentData

    Parameters

    • snapshot: DocumentSnapshot<AppModelType, DbModelType>

      The snapshot of the document to start at.

    Returns QueryStartAtConstraint

  • 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.

    Returns

    A QueryStartAtConstraint to pass to query().

    Parameters

    • Rest ...fieldValues: unknown[]

      The field values to start this query at, in order of the query's order by.

    Returns QueryStartAtConstraint

Settings

Member Visibility

Theme

Generated using TypeDoc