UseLiveQueryReturn
Interface: UseLiveQueryReturn<T>
Defined in: useLiveQuery.ts:35
Return type for useLiveQuery hook
Type Parameters
• T extends object
Properties
collection
collection: ComputedRef<Collection<T, string | number, {}, StandardSchemaV1<unknown, unknown>, T>>;
collection: ComputedRef<Collection<T, string | number, {}, StandardSchemaV1<unknown, unknown>, T>>;
Defined in: useLiveQuery.ts:38
The underlying query collection instance
data
data: ComputedRef<T[]>;
data: ComputedRef<T[]>;
Defined in: useLiveQuery.ts:37
Reactive array of query results in order
isCleanedUp
isCleanedUp: ComputedRef<boolean>;
isCleanedUp: ComputedRef<boolean>;
Defined in: useLiveQuery.ts:44
True when query has been cleaned up
isError
isError: ComputedRef<boolean>;
isError: ComputedRef<boolean>;
Defined in: useLiveQuery.ts:43
True when query encountered an error
isIdle
isIdle: ComputedRef<boolean>;
isIdle: ComputedRef<boolean>;
Defined in: useLiveQuery.ts:42
True when query hasn't started yet
isLoading
isLoading: ComputedRef<boolean>;
isLoading: ComputedRef<boolean>;
Defined in: useLiveQuery.ts:40
True while initial query data is loading
isReady
isReady: ComputedRef<boolean>;
isReady: ComputedRef<boolean>;
Defined in: useLiveQuery.ts:41
True when query has received first data and is ready
state
state: ComputedRef<Map<string | number, T>>;
state: ComputedRef<Map<string | number, T>>;
Defined in: useLiveQuery.ts:36
Reactive Map of query results (key → item)
status
status: ComputedRef<CollectionStatus>;
status: ComputedRef<CollectionStatus>;
Defined in: useLiveQuery.ts:39
Current query status
Subscribe to Bytes
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.
Subscribe to Bytes
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.