module@warp-drive/alien-signals/install

Function buildSignalConfig() sincev5.10.0

function buildSignalConfig(options: HooksOptions): ComposingSignalHooks;

Defined in: install.ts:171

Builds the SignalHooks that back WarpDrive's reactivity with the graph in @warp-drive/alien-signals/primitives. Each signal is a value-less SignalNode, so every notification counts as a change, and each memo is a MemoNode.

The hooks include a register hook that adds a SignalIntegration to them, which is how other frameworks' install entry points add their signals after this one. With nothing registered, willSyncFlushWatchers returns false and waitFor returns the promise it is given.

Importing @warp-drive/alien-signals/install already passes this function to setupSignals.

Parameters

options

HooksOptions

the HooksOptions that setupSignals passes in, passed on to each registered integration

Returns

ComposingSignalHooks

the signal hooks backed by the alien-signals graph

Example

// what importing '@warp-drive/alien-signals/install' does
import { setupSignals } from '@warp-drive/core/configure';
import { buildSignalConfig } from '@warp-drive/alien-signals/install';

setupSignals(buildSignalConfig);