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

    Class StartAtBlock

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

    Hierarchy (View Summary)

    Implements

    Index

    Constructors

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

      Parameters

      • start: StartAtClauseStart

        Index of the first document in the query (1-indexed)

      • included: boolean = true

        If true, the first document is in the result set, if false, it starts after this index

      Returns StartAtBlock

    Properties

    included: boolean = true

    If true, the first document is in the result set, if false, it starts after this index

    Index of the first document in the query (1-indexed)

    Accessors

    • get hasNext(): boolean

      Check whether or not this block as a following block

      Returns boolean

    • get leaf(): QueryBuildBlock

      Gets a reference to the block at the end of the chain

      Returns QueryBuildBlock

    • get next(): QueryBuildBlock | null

      A reference to the next query block or null if this block is the last

      Returns QueryBuildBlock | null

    • set next(value: QueryBuildBlock | null): void

      Sets the reference to the next query block

      Parameters

      Returns void

    • get previous(): QueryBuildBlock | null

      A reference to the previous query block if this block is the first

      Returns QueryBuildBlock | null

    • set previous(value: QueryBuildBlock | null): void

      Sets the reference to the previous query block

      Parameters

      Returns void

    • get root(): QueryBuildBlock

      Gets a reference to the block at the start of the chain

      Returns QueryBuildBlock

    Methods

    • Appends an end-at clause to the query

      Parameters

      • end: EndAtClauseEnd

        Index of the document in the global query from which to start

      • included: boolean = false

        Whether or not to include the document matching the clause

      Returns EndAtBlock

    • Converts this block to the corresponding query constraint

      Returns QueryStartAtConstraint

    • Converts the full chain to a firebase set of query constraints

      Returns QueryConstraint[]

      Firebase query constraints equivalent to this query