@jiway/firestorm-core - v1.1.1
    Preparing search index...

    Module query

    Classes

    EndAtBlock

    End-at query block that gives an ending document index for the query

    LimitBlock

    A limit query block that restricts the amount of documents retrieved by a number

    OrderByBlock

    Order by query block that orders the documents by a property

    Query

    A query represents an instruction given to the firestore engine to match a specific set of documents within a collection.

    QueryBuildBlock

    Base behavior for a query block

    StartAtBlock

    Start-at query block that gives a starting document index for the query

    StartBlock

    Initial query block of a query.

    WhereBlock

    Where clause query block that restricts the query to documents matching the query

    Interfaces

    ICanPrecedeEndAt

    Describes a query block that can create an end-at clause as its following block

    ICanPrecedeLimit

    Describes a query block that can create a limit clause as its following block

    ICanPrecedeOrderBy

    Describes a query block that can create an order by clause as its following block

    ICanPrecedeStartAt

    Describes a query block that can create a start at clause as its following block

    ICanPrecedeWhere

    Describes a query block that can create a where clause as its following block

    IQueryBuildBlock

    Describes the minimal requirements for a query block

    Type Aliases

    AggregationResult

    Type for the result of an aggregation query

    AggregationVerb

    Possible aggregation verbs.

    • count: Counts all the documents matching the query
    • sum: gets the sum of all the values in the field
    • average: averages the value in the field
    EndAtClauseEnd

    End for the End-at Clause

    ExplicitAggregationField

    Definition for an aggregation query field

    ExplicitAggregationQuery

    Definition for an aggreagation query

    InequalityOperators

    Inequality operators

    LimitClauseDirection

    Limit from for limit clauses

    LimitClauseLimit

    Limit for Limit clauses

    OrderClauseDirection

    Direction of the order for order clauses

    QueryClauseField

    Field name of the query clause

    StartAtClauseStart

    Start for the Start-at Clause

    WhereClauseOperator

    Operators available for where clauses

    WhereClauseValue

    Values for where clauses

    Variables

    inequalityOperators

    List of inequality operators

    Functions

    aggregationQueryToAggregateSpec

    Converts a firestorm aggregation query to a firestore aggregate spec

    isQueryBuildBlock

    Type guard for IQueryBuildBlock

    It works by duck typing the top level without checking the values of the properties so be mindful.

    paginate

    Appends a start-at and a limit block to the query to retrieve a portion of the request