Type: SignalOptions

API reference and details for SignalOptions from signals.dart.

SignalOptions#

Kind: class | Package: package:preact_signals

Class: SignalOptions#

Configuration options for a Signal.

Extends ReadonlySignalOptions to also support custom equality checkers, which control whether incoming values trigger update events.

Example Usage#

import 'package:preact_signals/preact_signals.dart';

final items = signal(
  [1, 2, 3],
  options: SignalOptions(
    name: 'item-list',
    equality: SignalEquality.deep(),
    watched: () => print('Items watch active'),
    unwatched: () => print('Items watch inactive'),
  ),
);

Members of SignalOptions#

Member	Type	Signature	Description
equalityCheck	`method`	`dart SignalEquality equalityCheck`	Get the active equality check
SignalOptions	`constructor`	`dart SignalOptions({super.name, super.watched, super.unwatched, SignalEquality? equality})`	Creates a new SignalOptions instance.
copyWith	`method`	`dart SignalOptions copyWith({String? name, void Function()? watched, void Function()? unwatched})`
==	`method`	`dart bool ==(Object other)`
hashCode	`method`	`dart int hashCode`

Class: SignalOptions#

Configuration options for a Signal extending signals.SignalOptions.

Members of SignalOptions#

Member	Type	Signature	Description
autoDispose	`field`	`dart bool autoDispose`	Automatically dispose the signal when there are no more listeners.
SignalOptions	`constructor`	`dart SignalOptions({super.name, this.autoDispose = false, super.watched, super.unwatched, super.equality})`	Creates a new SignalOptions instance.
copyWith	`method`	`dart SignalOptions copyWith({String? name, bool? autoDispose, void Function()? watched, void Function()? unwatched})`
==	`method`	`dart bool ==(Object other)`
hashCode	`method`	`dart int hashCode`

References#

The SignalOptions type is referenced and used in the following pages:

Signal (signals_flutter/core)
Ticker Signal (signals_flutter/signals)
FlutterSignal (signals_flutter/signals)
SignalEquality (signals_flutter/utilities)
Signal (signals_core/core)
SignalEquality (signals_core/utilities)
SignalsPreferUnifiedOptions (signals_lint/flutter)
Signal (signals/core)
TickerSignal (signals/signals)
FlutterSignal (signals/signals)
SignalEquality (signals/utilities)
useSignal (signals_hooks/hooks)
Signal (preact_signals/core)
SignalEquality (preact_signals/utilities)