SignalOptions

Options of useSignal.

Import#

import type { SignalOptions } from "@shadow-js/core";

Signature#

interface SignalOptions<T> {
  /**
   * Decides whether a write is a change: readers are notified only when it returns `false`.
   * `false` notifies on every write, even of the same value.
   * @default Object.is
   */
  equals?: Equals<T>;
  /**
   * Label shown by devtools and diagnostics.
   * @default undefined (the signal is unnamed)
   */
  name?: string;
}

Members#

Name	Type	Description
`T`	`T`
`equals?`	`equals?: Equals<T>`	Decides whether a write is a change: readers are notified only when it returns `false`. `false` notifies on every write, even of the same value.
`name?`	`name?: string`	Label shown by devtools and diagnostics.