UseLiveQueryReturn

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

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

The underlying query collection instance

data

data: TData;

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

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

True when query has been cleaned up

isError

isError: boolean;

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

True when query encountered an error

isIdle

isIdle: boolean;

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

True when query hasn't started yet

isLoading

isLoading: boolean;

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

True while initial query data is loading

isPersistedReady

isPersistedReady: boolean;

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

isReady

isReady: boolean;

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

True when query has received first data and is ready

persistedError

persistedError: unknown;

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

persistedStatus

persistedStatus: LiveQueryPersistedStatus;

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

state

state: Map<string | number, T>;

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

Reactive Map of query results (key → item)

status

status: CollectionStatus;

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

Current query status