LiveQuery
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:169
A live query instance bound to a specific Store.
LiveQuery represents an active, stateful query in the reactivity graph. Unlike
query definitions (LiveQueryDef), instances maintain state like execution counts,
timing data, and active subscriptions.
You typically don’t work with LiveQuery directly—use store.query() for one-shot
reads or store.subscribe() for reactive subscriptions. The instance is managed
automatically via reference counting.
Type Parameters
Section titled “Type Parameters”TResult
Section titled “TResult”TResult
The type of value the query returns
Properties
Section titled “Properties”__result!
Section titled “__result!”__result!:
TResult
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:177
Type-level only—extracts the result type from a LiveQuery
_tag:
"computed"|"db"|"graphql"|"signal"
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:173
Discriminator for the query type
[TypeId]
Section titled “[TypeId]”[TypeId]: typeof
TypeId
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:174
activeSubscriptions
Section titled “activeSubscriptions”activeSubscriptions:
Set<StackInfo>
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:194
Stack traces of active subscriptions (for debugging)
def:
LiveQueryDef<TResult,"def"> |SignalDef<TResult>
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:202
The definition that created this instance
destroy()
Section titled “destroy()”destroy: () =>
void
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:189
Removes the query from the reactivity graph
Returns
Section titled “Returns”void
executionTimes
Section titled “executionTimes”executionTimes:
number[]
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:200
Execution times in milliseconds (for performance monitoring)
id:
number
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:171
Unique identifier for this query instance
isDestroyed
Section titled “isDestroyed”isDestroyed:
boolean
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:191
Whether this query instance has been destroyed
label:
string
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:183
Human-readable label for debugging and devtools
results$
Section titled “results$”results$:
Atom<TResult,ReactivityGraphContext,RefreshReason>
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:180
The underlying reactive atom in the graph that holds the query result
run: (
args) =>TResult
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:186
Executes the query and returns the result
Parameters
Section titled “Parameters”debugRefreshReason?
Section titled “debugRefreshReason?”otelContext?
Section titled “otelContext?”Context
Returns
Section titled “Returns”TResult
runs:
number
Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:197
Number of times this query has been executed