Interface: UseLiveQueryReturn<T, TData>#

Defined in: useLiveQuery.svelte.ts:37

Return type for useLiveQuery hook

Type Parameters#

T#

T extends object

TData#

TData = T[]

Properties#

collection#

collection: Collection<T, string | number, {
}>;

collection: Collection<T, string | number, {
}>;

Defined in: useLiveQuery.svelte.ts:40

The underlying query collection instance

data#

data: TData;

data: TData;

Defined in: useLiveQuery.svelte.ts:39

Reactive array of query results in order, or single item when using findOne()

isCleanedUp#

isCleanedUp: boolean;

isCleanedUp: boolean;

Defined in: useLiveQuery.svelte.ts:46

True when query has been cleaned up

isError#

isError: boolean;

isError: boolean;

Defined in: useLiveQuery.svelte.ts:45

True when query encountered an error

isIdle#

isIdle: boolean;

isIdle: boolean;

Defined in: useLiveQuery.svelte.ts:44

True when query hasn't started yet

isLoading#

isLoading: boolean;

isLoading: boolean;

Defined in: useLiveQuery.svelte.ts:42

True while initial query data is loading

isReady#

isReady: boolean;

isReady: boolean;

Defined in: useLiveQuery.svelte.ts:43

True when query has received first data and is ready

state#

state: Map<string | number, T>;

state: Map<string | number, T>;

Defined in: useLiveQuery.svelte.ts:38

Reactive Map of query results (key → item)

status#

status: CollectionStatus;

status: CollectionStatus;

Defined in: useLiveQuery.svelte.ts:41

Current query status