UseConditionalLiveQueryResult

Defined in: useLiveQuery.ts:98

The result of a live query whose callback can disable it.

Extends#

• LiveQueryResultFlags

Type Parameters#

TResult#

TResult extends object

TKey#

TKey extends string | number

TData#

TData

TCollection#

TCollection

Properties#

collection#

collection: TCollection | undefined;

Defined in: useLiveQuery.ts:106

data#

data: TData | undefined;

Defined in: useLiveQuery.ts:105

health#

health: HealthNode | undefined;

Defined in: useLiveQuery.ts:80

The health tree for the query and every Collection it depends on, or undefined for a disabled query.

Inherited from#

LiveQueryResultFlags.health

isEnabled#

isEnabled: boolean;

Defined in: useLiveQuery.ts:108

isSyncError#

isSyncError: boolean;

Defined in: useLiveQuery.ts:75

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

Inherited from#

LiveQueryResultFlags.isSyncError

state#

state: ReadonlyMap<TKey, TResult> | undefined;

Defined in: useLiveQuery.ts:104

status#

status: UseLiveQueryStatus;

Defined in: useLiveQuery.ts:107