Class LimitBlock

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

Hierarchy (View Summary)

QueryBuildBlock
- LimitBlock

Index

Constructors

Properties

Accessors

hasNext leaf next previous root

Methods

toConstraint toConstraints

Constructors

constructor

new LimitBlock(limit: number, from: LimitClauseDirection): LimitBlock
Creates a limit query block that restricts the amount of documents retrieved by a number
Parameters
- limit: number
  The amount of documents retrieved at most
- from: LimitClauseDirection
  If the limit is applied to the starting documents retrieved or the ending
Returns LimitBlock
Overrides QueryBuildBlock.constructor
- Defined in packages/firestorm/src/query/query-builder/blocks/limit-block.ts:15

Properties

`Readonly`from

from: LimitClauseDirection

If the limit is applied to the starting documents retrieved or the ending

`Readonly`limit

limit: number

The amount of documents retrieved at most

Accessors

hasNext

get hasNext(): boolean
Check whether or not this block as a following block

Returns boolean
Inherited from QueryBuildBlock.hasNext
- Defined in packages/firestorm/src/query/query-builder/blocks/query-build-block.ts:69

`Protected`leaf

get leaf(): QueryBuildBlock
Gets a reference to the block at the end of the chain

Returns QueryBuildBlock
Inherited from QueryBuildBlock.leaf
- Defined in packages/firestorm/src/query/query-builder/blocks/query-build-block.ts:61

next

get next(): QueryBuildBlock | null
A reference to the next query block or null if this block is the last

Returns QueryBuildBlock | null
Inherited from QueryBuildBlock.next
- Defined in packages/firestorm/src/query/query-builder/blocks/query-build-block.ts:32
set next(value: QueryBuildBlock | null): void
Sets the reference to the next query block
Parameters
- value: QueryBuildBlock | null
  The soon to be next query block
Returns void
Inherited from QueryBuildBlock.next
- Defined in packages/firestorm/src/query/query-builder/blocks/query-build-block.ts:38

previous

get previous(): QueryBuildBlock | null
A reference to the previous query block if this block is the first

Returns QueryBuildBlock | null
Inherited from QueryBuildBlock.previous
- Defined in packages/firestorm/src/query/query-builder/blocks/query-build-block.ts:13
set previous(value: QueryBuildBlock | null): void
Sets the reference to the previous query block
Parameters
- value: QueryBuildBlock | null
  The soon to be previous query block
Returns void
Inherited from QueryBuildBlock.previous
- Defined in packages/firestorm/src/query/query-builder/blocks/query-build-block.ts:19

`Protected`root

get root(): QueryBuildBlock
Gets a reference to the block at the start of the chain

Returns QueryBuildBlock
Inherited from QueryBuildBlock.root
- Defined in packages/firestorm/src/query/query-builder/blocks/query-build-block.ts:53

Methods

toConstraint

toConstraint(): QueryLimitConstraint
Converts this block to the corresponding query constraint

Returns QueryLimitConstraint
Overrides QueryBuildBlock.toConstraint
- Defined in packages/firestorm/src/query/query-builder/blocks/limit-block.ts:23

toConstraints

toConstraints(): QueryConstraint[]
Converts the full chain to a firebase set of query constraints

Returns QueryConstraint[]
Firebase query constraints equivalent to this query
Inherited from QueryBuildBlock.toConstraints
- Defined in packages/firestorm/src/query/query-builder/blocks/query-build-block.ts:95