recordSignals

import { recordSignals } from 'pixi-silk/history';

function recordSignals(
   history: HistoryLike, 
   signals: 
  | Readonly<Record<string, Signal<unknown>>>
  | readonly Signal<unknown>[], 
   options?: RecordSignalsOptions
): SignalRecorder;

Records every change of signals into history, so undo works without writing commands. Changes made in the same synchronous run (one handler, one batch) become one step. Inside a transaction everything merges into the transaction’s step.

const doc = { name: signal('Layer'), x: signal(0) };

recordSignals(history, doc);
doc.x.value = 40; // history.undo() sets it back to 0

Parameters#

Returns#

SignalRecorder