Skip to content

InjectLiveQueryResult.md

Latest commit

 

History

History
136 lines (81 loc) · 2.61 KB

InjectLiveQueryResult.md

File metadata and controls

136 lines (81 loc) · 2.61 KB
id InjectLiveQueryResult
title InjectLiveQueryResult

Interface: InjectLiveQueryResult<TResult, TKey, TUtils>

Defined in: index.ts:26

The result of calling injectLiveQuery. Contains reactive signals for the query state and data.

Type Parameters

TResult

TResult extends object = any

TKey

TKey extends string | number = string | number

TUtils

TUtils extends Record<string, any> = { }

Properties

collection

collection: Signal<
  | Collection<TResult, TKey, TUtils, StandardSchemaV1<unknown, unknown>, TResult>
| null>;

Defined in: index.ts:36

A signal containing the underlying collection instance (null for disabled queries)

data

data: Signal<TResult[]>;

Defined in: index.ts:34

A signal containing the results as an array

isCleanedUp

isCleanedUp: Signal<boolean>;

Defined in: index.ts:48

A signal indicating whether the collection has been cleaned up

isError

isError: Signal<boolean>;

Defined in: index.ts:46

A signal indicating whether the collection has an error

isIdle

isIdle: Signal<boolean>;

Defined in: index.ts:44

A signal indicating whether the collection is idle

isLoading

isLoading: Signal<boolean>;

Defined in: index.ts:40

A signal indicating whether the collection is currently loading

isReady

isReady: Signal<boolean>;

Defined in: index.ts:42

A signal indicating whether the collection is ready

state

state: Signal<Map<TKey, TResult>>;

Defined in: index.ts:32

A signal containing the complete state map of results keyed by their ID

status

status: Signal<CollectionStatus | "disabled">;

Defined in: index.ts:38

A signal containing the current status of the collection