UseLiveQueryReturn

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

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

The underlying query collection instance

data#

data: TData;

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

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

health#

health: HealthNode | undefined;

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

isCleanedUp#

isCleanedUp: boolean;

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

True when query has been cleaned up

isCrashed#

isCrashed: boolean;

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

True when local storage or an invariant broke

isIdle#

isIdle: boolean;

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

True when query hasn't started yet

isLoading#

isLoading: boolean;

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

True while initial query data is loading

isLoadingError#

isLoadingError: boolean;

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

True when the first load failed

isReady#

isReady: boolean;

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

True when query has received first data and is ready

isSyncError#

isSyncError: boolean;

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

True when data is shown and health has a problem

state#

state: Map<string | number, T>;

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

Reactive Map of query results (key → item)

status#

status: CollectionStatus;

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

Current query status