LogoSignals.dart
Copy Markdown
rodydavis/signals.dart 999999

Type: TimerSignal

API reference and details for TimerSignal from signals.dart.

TimerSignal#

Kind: class & function  |  Package: package:signals_core

Class: TimerSignal#

Emit recurring TimerSignalEvent aka AsyncSignal

Members of TimerSignal#

Member Type Signature Description
every field dart Duration every Trigger an TimerSignalEvent every duration
TimerSignal constructor dart TimerSignal({required this.every, super.cancelOnError, AsyncSignalOptions ? options, @Deprecated('Use options: AsyncSignalOptions(autoDispose: ...) instead') bool? autoDispose, @Deprecated('Use options: AsyncSignalOptions(name: ...) instead') String? debugLabel}) Emit recurring TimerSignalEvent aka AsyncSignal

Function: timerSignal#

TimerSignal timerSignal(Duration every, {bool? cancelOnError, AsyncSignalOptions<TimerSignalEvent>? options, @Deprecated('Use options: AsyncSignalOptions(autoDispose: ...) instead') bool? autoDispose, @Deprecated('Use options: AsyncSignalOptions(name: ...) instead') String? debugLabel})

Create a TimerSignal

References#

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