Skip to content
TanStackDB
API Reference

UseLiveQueryReturn

Defined in: useLiveQuery.ts:55

The status and flag refs every useLiveQuery result has.

Extends

Type Parameters

TContext

TContext extends Context

Properties

collection

ts
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:60

data

ts
data: ComputedRef<InferResultType<TContext>>;

Defined in: useLiveQuery.ts:59

state

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

Defined in: useLiveQuery.ts:58

status

ts
status: ComputedRef<CollectionStatus>;

Defined in: useLiveQuery.ts:50

Inherited from

ts
UseLiveQueryFlags.status
Edit on GitHub
useLiveQuery
UseLiveQueryReturnWithCollection