Effect<Value>.periodic constructor

Effect<Value>.periodic(
  1. Duration interval,
  2. Value computation(
    1. int computationCount
    ), {
  3. Value onDone()?,
  4. Value onError(
    1. Object error,
    2. StackTrace stackTrace
    )?,
  5. bool? cancelOnError,
})

Emits a value on every interval using the synchronous computation. Optional callbacks allow consumers to provide completion or error values, or to opt into canceling the subscription when an error occurs.

Example:

final ticker = Effect.periodic(
  const Duration(seconds: 1),
  (count) => "tick $count",
);

Implementation

factory Effect.periodic(
  Duration interval,
  Value Function(int computationCount) computation, {
  Value Function()? onDone,
  Value Function(Object error, StackTrace stackTrace)? onError,
  bool? cancelOnError,
}) =>
    Effect.stream(
      stream: Stream.periodic(interval, computation),
      onDone: onDone,
      onError: onError,
      cancelOnError: cancelOnError,
    );