module@warp-drive/alien-signals/primitives

Function consumeSignal() sincev5.10.0

function consumeSignal(signal: SignalNode): void;

Defined in: primitives.ts:196

Records that the memo whose function is running read signal, so that a later notifySignal makes that memo recompute. Outside of a memo it does nothing; use Watcher.watch to observe a signal from outside the graph.

Parameters

signal

SignalNode

the signal that was read

Returns

void

Example

import { consumeSignal, createMemo, readMemo } from '@warp-drive/alien-signals/primitives';

const fullName = createMemo(user, 'fullName', () => {
  consumeSignal(nameSignal);
  return `${user.first} ${user.last}`;
});
readMemo(fullName);