Interface ICanPrecedeStartAt

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

interface ICanPrecedeStartAt {
paginate(pageLength: number, pageIndex: number): LimitBlock;
startAt(start: StartAtClauseStart): StartAtBlock;
}

Implemented by

Index

Methods

paginate startAt

Methods

paginate

paginate(pageLength: number, pageIndex: number): LimitBlock
Appends a start-at, end-at and limit block to the query to retrieve a portion of the request
Parameters
- pageLength: number
  Length of the page
- pageIndex: number
  Index of the page (0-indexed)
Returns LimitBlock
- Defined in packages/firestorm/src/query/query-builder/blocks/start-at-block.ts:60

startAt

startAt(start: StartAtClauseStart): StartAtBlock
Appends a start-at clause to the query
Parameters
- start: StartAtClauseStart
  Index of the document in the global query from which to start (1-indexed)
Returns StartAtBlock
- Defined in packages/firestorm/src/query/query-builder/blocks/start-at-block.ts:53