Type: ReadonlySignalOptions

API reference and details for ReadonlySignalOptions from signals.dart.

ReadonlySignalOptions#

Kind: class | Package: package:preact_signals

Class: ReadonlySignalOptions#

Configuration options for a ReadonlySignal.

Allows intercepting the signal's active subscription state changes via watched and unwatched callback event listeners. This is extremely useful for initiating or canceling active background fetching, web sockets, or timer loops.

Example Usage#

import 'package:preact_signals/preact_signals.dart';

final stockTicker = signal(
  0.0,
  options: ReadonlySignalOptions(
    name: 'stock-ticker',
    watched: () => print('Stock Ticker is actively being listened to!'),
    unwatched: () => print('No more listeners, sleeping the ticker.'),
  ),
);

Members of ReadonlySignalOptions#

Member	Type	Signature	Description
watched	`field`	`dart void Function()? watched`	Callback called when the signal goes from 0 to >=1 listeners.
unwatched	`field`	`dart void Function()? unwatched`	Callback called when the signal goes from >=1 to 0 listeners.
ReadonlySignalOptions	`constructor`	`dart ReadonlySignalOptions({super.name, this.watched, this.unwatched})`	Creates a new ReadonlySignalOptions instance.
copyWith	`method`	`dart ReadonlySignalOptions copyWith({String? name, void Function()? watched, void Function()? unwatched})`	Creates a copy of this options with custom overrides.
==	`method`	`dart bool ==(Object other)`
hashCode	`method`	`dart int hashCode`

Class: ReadonlySignalOptions#

Configuration options for a ReadonlySignal extending signals.ReadonlySignalOptions.

Members of ReadonlySignalOptions#

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

References#

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

Signal (signals_flutter/core)
Signal (signals_core/core)
Signal (signals/core)
Signal (preact_signals/core)