Go to console

A Query refers to a Query which you can read or listen to. You can also construct refined Query objects by adding filters and ordering.

Index

Constructors

Protected constructor

Properties

firestore

firestore: Firestore

The Firestore for the Firestore database (useful for performing transactions, etc.).

Methods

endAt

  • endAt(snapshot: DocumentSnapshot): Query
  • 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.

    Parameters

    Returns Query

    The created Query.

  • endAt(...fieldValues: any[]): 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.

    Parameters

    • Rest ...fieldValues: any[]

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

    Returns Query

    The created Query.

endBefore

  • endBefore(snapshot: DocumentSnapshot): 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.

    Parameters

    Returns Query

    The created Query.

  • endBefore(...fieldValues: any[]): 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.

    Parameters

    • Rest ...fieldValues: any[]