API Reference

This page provides an architectural matrix of all subpath exports and functions in @banksia/signals.

Complete TypeDoc Documentation

For exhaustive TypeScript type declarations, member signatures, inheritance diagrams, and symbol documentation generated directly from source code, explore our standalone TypeDoc API Portal.

`@banksia/signals` (Core Engine)

The core engine provides fundamental primitives, proxy wrapping, microtask scheduling, and telemetry.

Export	Type	Description
`signal(initialValue)`	Function	Creates a foundational reactive signal container with `.value`.
`computed(getter, name?)`	Function	Creates a lazily evaluated, memoized derived computation.
`effect(fn, name?)`	Function	Creates an auto-tracking reactive side-effect observer.
`makeReactive(target)`	Function	Wraps an object, class instance, or collection in a reactive Proxy.
`isReactive(target)`	Function	Checks whether a value is an active reactive Proxy.
`toRaw(proxy)`	Function	Unwraps a reactive Proxy to access the underlying raw target.
`batch(fn)`	Function	Executes a transactional callback, deferring reactions until completion.
`flushBatch()`	Function	Synchronously flushes all pending microtask batch notifications.
`registerReactivityHooks(hooks)`	Function	Registers global lifecycle observability callbacks.
`observe(target, hooks)`	Function	Subscribes to changes on a specific reactive object or store.
`createReactivityHub(options)`	Function	Creates an isolated telemetry buffer and dispatcher hub.
`getDependencyGraph(target)`	Function	Retrieves the active subscriber dependency graph for a target.
`configureSignalsDebug(config)`	Function	Enables console mutation logging and batch tracing.
`registerOnReaction(cb)`	Function	Attaches a callback executed whenever a subscriber is notified in batch.

`@banksia/signals/react`

React 18 & 19 integration hooks and Higher-Order Components.

Export	Type	Description
`useReactive(target)`	Hook	Subscribes a React component to a reactive proxy object or domain store.
`observer(Component)`	HOC	Converts a functional component into an auto-tracking reactive observer.
`useSignal(initial)`	Hook	Creates and memoizes a component-scoped `Signal`.
`useComputed(fn)`	Hook	Creates and memoizes a component-scoped `computed()` derivation.

`@banksia/signals/lit`

Lit and Web Component lifecycle controllers.

Export	Type	Description
`SignalsController`	Class	Lit `ReactiveController` binding reactive stores to component rendering.

`@banksia/signals/solid`

SolidJS reactivity bridge.

Export	Type	Description
`createSolidSignalBridge(target)`	Function	Bridges a `@banksia/signals` reactive store into SolidJS signal accessors.

`@banksia/signals/vanilla`

Zero-dependency DOM binding helpers.

Export	Type	Description
`bindText(element, getter)`	Function	Synchronizes an HTML element's `textContent` with reactive state.
`bindDOM(element, updater)`	Function	Reactive updater for classes, attributes, styles, and properties.

`@banksia/signals/devtools`

Observability bridge and Chrome DevTools MCP inspection.

Export	Type	Description
`initDevTools(options)`	Function	Mounts `window.__BANKSIA_SIGNALS_DEVTOOLS__` global runtime inspector.
`connectDevTools(options)`	Function	Connects a custom DevTools bridge listener.
`disconnectDevTools()`	Function	Disconnects the global DevTools bridge and detaches hooks.
`getDevToolsBridge(options)`	Function	Retrieves the singleton `DevToolsBridge` instance.
`DevToolsBridge`	Class	DevTools bridge class managing telemetry ring buffers and sandboxing.

ON THIS PAGE

API Reference#

@banksia/signals (Core Engine)#

@banksia/signals/react#

@banksia/signals/lit#

@banksia/signals/solid#

@banksia/signals/vanilla#