UseLiveQueryReturn

Defined in: useLiveQuery.ts:72

Status, persistence, and error refs every useLiveQuery result has.

Extends#

• UseLiveQueryFlags

Type Parameters#

TContext#

TContext extends Context

Properties#

collection#

collection: ComputedRef<Collection<{ [K in string | number | symbol]: ResultValue<TContext>[K] }, string | number, {
}, StandardSchemaV1<unknown, unknown>, { [K in string | number | symbol]: ResultValue<TContext>[K] }>>;

Defined in: useLiveQuery.ts:77

data#

data: ComputedRef<InferResultType<TContext>>;

Defined in: useLiveQuery.ts:76

health#

health: ComputedRef<HealthNode | undefined>;

Defined in: useLiveQuery.ts:69

Inherited from#

UseLiveQueryFlags.health

isCleanedUp#

isCleanedUp: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:66

Inherited from#

UseLiveQueryFlags.isCleanedUp

isCrashed#

isCrashed: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:65

Local storage or an invariant broke. Only a cascade cleanup and a fresh start recover.

Inherited from#

UseLiveQueryFlags.isCrashed

isIdle#

isIdle: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:61

Inherited from#

UseLiveQueryFlags.isIdle

isLoading#

isLoading: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:59

Inherited from#

UseLiveQueryFlags.isLoading

isLoadingError#

isLoadingError: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:63

The first load failed: there is nothing to show.

Inherited from#

UseLiveQueryFlags.isLoadingError

isReady#

isReady: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:60

Inherited from#

UseLiveQueryFlags.isReady

isSyncError#

isSyncError: ComputedRef<boolean>;

Defined in: useLiveQuery.ts:68

The data is shown, and a sync problem or failed request is in health.

Inherited from#

UseLiveQueryFlags.isSyncError

state#

state: ComputedRef<Map<string | number, { [K in string | number | symbol]: ResultValue<TContext>[K] }>>;

Defined in: useLiveQuery.ts:75

status#

status: ComputedRef<CollectionStatus>;

Defined in: useLiveQuery.ts:58

Inherited from#

UseLiveQueryFlags.status