LiveQueryCollectionUtils

type LiveQueryCollectionUtils = UtilsRecord & object;

Defined in: packages/db/src/query/live/collection-config-builder.ts:58

Type Declaration#

[LIVE_QUERY_INTERNAL]#

[LIVE_QUERY_INTERNAL]: LiveQueryInternalUtils;

getWindow()#

getWindow: () => 
  | {
  limit: number;
  offset: number;
}
  | undefined;

Gets the current window (offset and limit) for an ordered query.

Returns#

| { limit: number; offset: number; } | undefined

The current window settings, or undefined if the query is not windowed

lastSubsetError#

readonly lastSubsetError: unknown | undefined;

Most recent subset-load failure observed by this live query.

setWindow()#

setWindow: (options) => true | Promise<void>;

Sets the offset and limit of the query's window, its ordered view. A windowed query has an orderBy. A findOne keeps its compiled limit (1, or 0 for .limit(0).findOne()); an ordered findOne has a movable window, and an unordered one is a fixed one-row result that accepts only its compiled limit at offset 0.

Parameters#

options#

WindowOptions

Returns#

true | Promise<void>

true if no subset loading was triggered, or Promise<void> that resolves when the subset has been loaded

Throws#

SetWindowRequiresOrderByError if the query is neither windowed nor a findOne, or an unordered findOne would move its offset.

Throws#

SetWindowFindOneLimitError if a findOne would change its limit.