Skip to content

Signal

Defined in: packages/@livestore/livestore/src/live-queries/signal.ts:91

A live signal instance bound to a specific Store.

Signal instances are created internally when you use a SignalDef with the Store. You typically don’t construct these directly—use signal to create definitions and store.setSignal() / store.query() to interact with them.

  • LiveStoreQueryBase<T>

T

  • ISignal<T>

__result!: T

Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:210

Type-level only—extracts the result type from a LiveQuery

ISignal.__result!

LiveStoreQueryBase.__result!


_tag: "signal"

Defined in: packages/@livestore/livestore/src/live-queries/signal.ts:92

ISignal._tag

LiveStoreQueryBase._tag


[TypeId]: typeof TypeId = TypeId

Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:212

ISignal.[TypeId]

LiveStoreQueryBase.[TypeId]


activeSubscriptions: Set<StackInfo>

Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:222

Stack traces of active subscriptions (for debugging)

ISignal.activeSubscriptions

LiveStoreQueryBase.activeSubscriptions


def: SignalDef<T>

Defined in: packages/@livestore/livestore/src/live-queries/signal.ts:97

ISignal.def

LiveStoreQueryBase.def


executionTimes: number[] = []

Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:233

Execution times in milliseconds (for performance monitoring)

ISignal.executionTimes

LiveStoreQueryBase.executionTimes


id: number

Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:211

Unique identifier for this query instance

ISignal.id

LiveStoreQueryBase.id


isDestroyed: boolean = false

Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:236

Whether this query instance has been destroyed

ISignal.isDestroyed

LiveStoreQueryBase.isDestroyed


label: string

Defined in: packages/@livestore/livestore/src/live-queries/signal.ts:94

Human-readable label for the query for debugging

ISignal.label

LiveStoreQueryBase.label


reactivityGraph: ReactivityGraph

Defined in: packages/@livestore/livestore/src/live-queries/signal.ts:95

ISignal.reactivityGraph

LiveStoreQueryBase.reactivityGraph


readonly ref: Ref<T, ReactivityGraphContext, RefreshReason>

Defined in: packages/@livestore/livestore/src/live-queries/signal.ts:93

The underlying reactive reference in the graph

ISignal.ref


results$: Ref<T, ReactivityGraphContext, RefreshReason>

Defined in: packages/@livestore/livestore/src/live-queries/signal.ts:96

ISignal.results$

LiveStoreQueryBase.results$

get runs(): number

Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:226

Number of times this query has been executed

number

ISignal.runs

LiveStoreQueryBase.runs

destroy(): void

Defined in: packages/@livestore/livestore/src/live-queries/signal.ts:134

void

ISignal.destroy

LiveStoreQueryBase.destroy


get(): T

Defined in: packages/@livestore/livestore/src/live-queries/signal.ts:130

T

ISignal.get


run(args): T

Defined in: packages/@livestore/livestore/src/live-queries/base-class.ts:239

RefreshReason

Context

T

ISignal.run

LiveStoreQueryBase.run


set(value): void

Defined in: packages/@livestore/livestore/src/live-queries/signal.ts:126

T

void

ISignal.set