Type: ComputedOptions

API reference and details for ComputedOptions from signals.dart.

ComputedOptions#

Kind: class | Package: package:preact_signals

Class: ComputedOptions#

Configuration options for a Computed signal.

Enables configuring debugging names and subscription state event listeners for computed derivations.

Example Usage#

import 'package:preact_signals/preact_signals.dart';

final count = signal(0);
final doubleCount = computed(
  () => count.value * 2,
  options: ComputedOptions(
    name: 'double-count',
    watched: () => print('Computed doubleCount is active'),
    unwatched: () => print('Computed doubleCount is inactive'),
  ),
);

Members of ComputedOptions#

Member	Type	Signature	Description
ComputedOptions	`constructor`	`dart ComputedOptions({super.name, super.watched, super.unwatched})`	Creates a new ComputedOptions instance.
copyWith	`method`	`dart ComputedOptions copyWith({String? name, void Function()? watched, void Function()? unwatched})`
==	`method`	`dart bool ==(Object other)`
hashCode	`method`	`dart int hashCode`

Class: ComputedOptions#

Configuration options for a Computed extending signals.ComputedOptions.

Members of ComputedOptions#

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

References#

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

Signal (signals_flutter/core)
Computed (signals_flutter/core)
FlutterComputed (signals_flutter/signals)
Signal (signals_core/core)
Computed (signals_core/core)
SignalsPreferUnifiedOptions (signals_lint/flutter)
Signal (signals/core)
Computed (signals/core)
FlutterComputed (signals/signals)
Signal (preact_signals/core)
Computed (preact_signals/core)