module@warp-drive/core/configure

Function registerSignals() sincev5.10.0

function registerSignals<T>(buildConfig: (options: HooksOptions) => SignalHooks<T>): void;

Defined in: warp-drive-packages/core/src/signals/reactivity/configure.ts:227

Adds the hooks built by buildConfig to the configured signals implementation if it composes other implementations, such as @warp-drive/alien-signals, and otherwise configures them with setupSignals.

A framework's install entry point calls this rather than setupSignals, so that importing @warp-drive/alien-signals/install first lets every framework on the page share its signals and memos.

Type Parameters

T

T

Parameters

buildConfig

(options: HooksOptions) => SignalHooks<T>

a function that takes options and returns a configuration object

Returns

void

Example

import { registerSignals } from '@warp-drive/core/configure';

registerSignals(buildSignalConfig);