Interface: UseLiveQueryReturn<T, TData>#

Defined in: packages/svelte-db/src/useLiveQuery.svelte.ts:47

Return type for useLiveQuery hook

Type Parameters#

T#

T extends object

TData#

TData = T[]

Properties#

collection#

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

Defined in: packages/svelte-db/src/useLiveQuery.svelte.ts:50

The underlying query collection instance

data#

data: TData;

Defined in: packages/svelte-db/src/useLiveQuery.svelte.ts:49

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

isCleanedUp#

isCleanedUp: boolean;

Defined in: packages/svelte-db/src/useLiveQuery.svelte.ts:56

True when query has been cleaned up

isError#

isError: boolean;

Defined in: packages/svelte-db/src/useLiveQuery.svelte.ts:55

True when query encountered an error

isIdle#

isIdle: boolean;

Defined in: packages/svelte-db/src/useLiveQuery.svelte.ts:54

True when query hasn't started yet

isLoading#

isLoading: boolean;

Defined in: packages/svelte-db/src/useLiveQuery.svelte.ts:52

True while initial query data is loading

isReady#

isReady: boolean;

Defined in: packages/svelte-db/src/useLiveQuery.svelte.ts:53

True when query has received first data and is ready

state#

state: Map<string | number, T>;

Defined in: packages/svelte-db/src/useLiveQuery.svelte.ts:48

Reactive Map of query results (key → item)

status#

status: CollectionStatus;

Defined in: packages/svelte-db/src/useLiveQuery.svelte.ts:51

Current query status