Class QueryResult<T>

Predicate based query.

Type Parameters

T extends BaseObject = any

Index

Constructors

Accessors

objects query results

Methods

first run runSync subscribe

Constructors

constructor

new QueryResult<T extends BaseObject = any>(
_queryContext: QueryContext<T>,
query: Query<T>,
): QueryResult<T>
Type Parameters
- T extends BaseObject = any
Parameters
- _queryContext: QueryContext<T>
- query: Query<T>
Returns QueryResult<T>
- Defined in packages/core/echo/echo-db/dist/types/src/query/query-result.d.ts:83

Accessors

objects

get objects(): T[]
Returns T[]
- Defined in packages/core/echo/echo-db/dist/types/src/query/query-result.d.ts:86

query

get query(): Query<T>
Returns Query<T>
- Defined in packages/core/echo/echo-db/dist/types/src/query/query-result.d.ts:84

results

get results(): QueryResultEntry<T>[]
Returns QueryResultEntry<T>[]
- Defined in packages/core/echo/echo-db/dist/types/src/query/query-result.d.ts:85

Methods

first

first(opts?: { timeout?: number }): Promise<T>
Parameters
- Optionalopts: { timeout?: number }
Returns Promise<T>
- Defined in packages/core/echo/echo-db/dist/types/src/query/query-result.d.ts:94

run

run(timeout?: { timeout?: number }): Promise<OneShotQueryResult<T>>
Execute the query once and return the results. Does not subscribe to updates.
Parameters
- Optionaltimeout: { timeout?: number }
Returns Promise<OneShotQueryResult<T>>
- Defined in packages/core/echo/echo-db/dist/types/src/query/query-result.d.ts:91

runSync

runSync(): QueryResultEntry<T>[]
Runs the query synchronously and returns all results. WARNING: This method will only return the data already cached and may return incomplete results. Use this.run() for a complete list of results stored on-disk.

Returns QueryResultEntry<T>[]
- Defined in packages/core/echo/echo-db/dist/types/src/query/query-result.d.ts:102

subscribe(
callback?: (query: QueryResult<T>) => void,
opts?: QuerySubscriptionOptions,
): CleanupFn
Subscribe to query results. Updates only when the identity or the order of the objects changes. Does not update when the object properties change.
Parameters
- Optionalcallback: (query: QueryResult<T>) => void
- Optionalopts: QuerySubscriptionOptions
Returns CleanupFn
- Defined in packages/core/echo/echo-db/dist/types/src/query/query-result.d.ts:108