UseLiveQueryReturn

Defined in: useLiveQuery.ts:55

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:58

The underlying query collection instance

data

data: ComputedRef<InferResultType<TContext>>;

Defined in: useLiveQuery.ts:57

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

isCleanedUp

isCleanedUp: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:67

True when query has been cleaned up

isError

isError: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:66

True when query encountered an error

isIdle

isIdle: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:65

True when query hasn't started yet

isLoading

isLoading: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:60

True while initial query data is loading

isPersistedReady

isPersistedReady: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:63

isReady

isReady: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:61

True when query has received first data and is ready

persistedError

persistedError: ComputedRef<unknown>;

Defined in: useLiveQuery.ts:64

persistedStatus

persistedStatus: ComputedRef<LiveQueryPersistedStatus>;

Defined in: useLiveQuery.ts:62

state

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

Defined in: useLiveQuery.ts:56

Reactive Map of query results (key → item)

status

status: ComputedRef<CollectionStatus>;

Defined in: useLiveQuery.ts:59

Current query status