QueryResult
Defined in: src/query/queryResult.ts:14
The result of a query. Holds the fetched entities and supports cursor-based pagination.
Type Parameters
Section titled “Type Parameters”TEntity
Section titled “TEntity”TEntity = Entity
The shape of each entity, inferred from the query builder
(a full Entity, or a projected object inferred from a select() selection).
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new QueryResult<
TEntity>(entities,queryBuilder,cursor,limit,validAtBlock):QueryResult<TEntity>
Defined in: src/query/queryResult.ts:31
Parameters
Section titled “Parameters”entities
Section titled “entities”TEntity[]
queryBuilder
Section titled “queryBuilder”BaseQueryBuilder<TEntity>
cursor
Section titled “cursor”string | undefined
number | undefined
validAtBlock
Section titled “validAtBlock”bigint | undefined
Returns
Section titled “Returns”QueryResult<TEntity>
Properties
Section titled “Properties”entities
Section titled “entities”entities:
TEntity[]
Defined in: src/query/queryResult.ts:15
Accessors
Section titled “Accessors”cursor
Section titled “cursor”Get Signature
Section titled “Get Signature”get cursor():
string|undefined
Defined in: src/query/queryResult.ts:27
Returns
Section titled “Returns”string | undefined
queryBuilder
Section titled “queryBuilder”Get Signature
Section titled “Get Signature”get queryBuilder():
BaseQueryBuilder<TEntity>
Defined in: src/query/queryResult.ts:23
Returns
Section titled “Returns”BaseQueryBuilder<TEntity>
Methods
Section titled “Methods”hasNextPage()
Section titled “hasNextPage()”hasNextPage():
boolean
Defined in: src/query/queryResult.ts:67
Returns
Section titled “Returns”boolean
next()
Section titled “next()”next():
Promise<void>
Defined in: src/query/queryResult.ts:46
Returns
Section titled “Returns”Promise<void>