toStreamSignal method

StreamSignal<T> toStreamSignal({
  1. bool? cancelOnError,
  2. String? debugLabel,
  3. T? initialValue,
  4. bool autoDispose = false,
  5. bool lazy = true,
  6. List<ReadonlySignal> dependencies = const [],
  7. void onDone()?,
})

Convert a stream to a signal

import 'package:signals/signals.dart';

Stream<int> createStream() async* {
    yield 1;
    yield 2;
    yield 3;
}
final stream = createStream();
final signal = stream.toSignal();

For returning a signal with the value that can be accessed sync use stream.toSyncSignal instead.

Implementation

StreamSignal<T> toStreamSignal({
  bool? cancelOnError,
  String? debugLabel,
  T? initialValue,
  bool autoDispose = false,
  bool lazy = true,
  List<ReadonlySignal<dynamic>> dependencies = const [],
  void Function()? onDone,
}) {
  return streamSignal<T>(
    () => this,
    cancelOnError: cancelOnError,
    debugLabel: debugLabel,
    initialValue: initialValue,
    autoDispose: autoDispose,
    lazy: lazy,
    dependencies: dependencies,
    onDone: onDone,
  );
}