Module: index#

Remarks

Core Architecture#

• Deep Proxy Traps: makeReactive wraps objects, classes, arrays, Sets, and Maps in fine-grained traps.
• Reactivity Primitives: signal, computed, and effect provide state holding, derived values, and side effects.
• Batching & Scheduling: batch and flushBatch collapse state mutations in the same tick into a single reaction cycle.
• Observability Pipeline: registerReactivityHooks, observe, and createReactivityHub enable un-opinionated telemetry, profiling, and DevTools integration.

Subpath Exports#

• @banksia/signals (or signals): Main entrypoint exposing core reactivity, proxies, and observability.
• @banksia/signals/react (or signals/react): React integration hooks (useReactive, useSignal, useComputed, observer).
• @banksia/signals/lit (or signals/lit): Lit element controller (SignalsController).
• @banksia/signals/solid (or signals/solid): SolidJS reactive bridge (createSolidSignalBridge).
• @banksia/signals/vanilla (or signals/vanilla): Vanilla DOM synchronization helpers (bindDOM, bindText).

Table of contents#

Classes#

• SignalImpl

Interfaces#

• BatchStats
• ChangeEvent
• DependencyGraphNode
• ExecutionContext
• HubOptions
• MutationEvent
• ReactiveConsumer
• ReactiveSource
• ReactiveSourceMeta
• ReactivityHooks
• ReactivityHub
• ReadonlySignal
• Signal
• SignalsDebugConfig
• Subscriber

Type Aliases#

• DisposeFn
• EffectFn

Functions#

• batch
• computed
• configureSignalsDebug
• createReactivityHub
• effect
• flushBatch
• getDependencyGraph
• hasBatchObservers
• hasErrorObservers
• hasExecuteObservers
• hasNotifyObservers
• hasScheduleObservers
• hasTrackObservers
• isReactive
• makeReactive
• observe
• registerOnMutation
• registerOnReaction
• registerReactivityHooks
• signal
• toRaw