UseLiveQueryReturn

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

Return type for useLiveQuery hook

Type Parameters

T

T extends object

TData

TData = T[]

Properties

collection

ts

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

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

The underlying query collection instance

data

ts

data: TData;

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

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

isCleanedUp

ts

isCleanedUp: boolean;

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

True when query has been cleaned up

isError

ts

isError: boolean;

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

True when query encountered an error

isIdle

ts

isIdle: boolean;

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

True when query hasn't started yet

isLoading

ts

isLoading: boolean;

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

True while initial query data is loading

isPersistedReady

ts

isPersistedReady: boolean;

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

isReady

ts

isReady: boolean;

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

True when query has received first data and is ready

persistedError

ts

persistedError: unknown;

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

persistedStatus

ts

persistedStatus: LiveQueryPersistedStatus;

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

state

ts

state: Map<string | number, T>;

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

Reactive Map of query results (key → item)

status

ts

status: CollectionStatus;

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

Current query status