UseLiveQueryReturn

Defined in: useLiveQuery.ts:46

Return type for useLiveQuery hook

Type Parameters#

TContext#

TContext extends Context

Properties#

collection#

collection: ComputedRef<Collection<{ [K in string | number | symbol]: ResultValue<TContext>[K] }, string | number, {
}, StandardSchemaV1<unknown, unknown>, { [K in string | number | symbol]: ResultValue<TContext>[K] }>>;

Defined in: useLiveQuery.ts:49

The underlying query collection instance

data#

data: ComputedRef<InferResultType<TContext>>;

Defined in: useLiveQuery.ts:48

Reactive array of query results in order, or single result for findOne queries

isCleanedUp#

isCleanedUp: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:58

True when query has been cleaned up

isError#

isError: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:57

True when query encountered an error

isIdle#

isIdle: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:56

True when query hasn't started yet

isLoading#

isLoading: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:51

True while initial query data is loading

isPersistedReady#

isPersistedReady: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:54

isReady#

isReady: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:52

True when query has received first data and is ready

persistedError#

persistedError: ComputedRef<unknown>;

Defined in: useLiveQuery.ts:55

persistedStatus#

persistedStatus: ComputedRef<LiveQueryPersistedStatus>;

Defined in: useLiveQuery.ts:53

state#

state: ComputedRef<Map<string | number, { [K in string | number | symbol]: ResultValue<TContext>[K] }>>;

Defined in: useLiveQuery.ts:47

Reactive Map of query results (key → item)

status#

status: ComputedRef<CollectionStatus>;

Defined in: useLiveQuery.ts:50

Current query status