Type: AsyncSignalOptions

API reference and details for AsyncSignalOptions from signals.dart.

AsyncSignalOptions#

Kind: class | Package: package:signals_core

Class: AsyncSignalOptions#

Configuration options for an AsyncSignal.

Members of AsyncSignalOptions#

Member	Type	Signature	Description
initialValue	`field`	`dart T? initialValue`	The initial value of the async signal.
dependencies	`field`	`dart List<ReadonlySignal> dependencies`	The list of dependencies to watch/listen to.
onDone	`field`	`dart void Function()? onDone`	Optional function called when a stream completes.
cancelOnError	`field`	`dart bool? cancelOnError`	Whether to cancel the stream subscription on error.
lazy	`field`	`dart bool lazy`	Whether the execution is lazy.
AsyncSignalOptions	`constructor`	`dart AsyncSignalOptions({this.initialValue, this.dependencies = const [], this.onDone, this.cancelOnError, this.lazy = true, super.name, super.autoDispose, super.watched, super.unwatched})`	Creates a new AsyncSignalOptions instance.
copyWith	`method`	`dart AsyncSignalOptions copyWith({T? initialValue, List<ReadonlySignal >? dependencies, void Function()? onDone, bool? cancelOnError, bool? lazy, bool? autoDispose, 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`

References#

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

Signal (signals_flutter/core)
FutureSignal (signals_flutter/async)
AsyncSignal (signals_flutter/async)
Stream (signals_flutter/async)
Signal (signals_core/core)
FutureSignal (signals_core/async)
AsyncSignal (signals_core/async)
Stream (signals_core/async)
SignalsPreferUnifiedOptions (signals_lint/flutter)
Signal (signals/core)
FutureSignal (signals/async)
AsyncSignal (signals/async)
Stream (signals/async)
useAsyncComputed (signals_hooks/hooks)