shareValue method

ValueStream<T> shareValue()

Convert the current Stream into a new ValueStream that can be listened to multiple times. It will automatically begin emitting items when first listened to, and shut down when no listeners remain.

This is useful for converting a single-subscription stream into a broadcast Stream. It's also useful for providing sync access to the latest emitted value.

It will replay the latest emitted value to any new listener.

Example

// Convert a single-subscription fromIterable stream into a broadcast
// stream that will emit the latest value to any new listeners
final stream =  Stream.fromIterable([1, 2, 3]).shareValue();

// Start listening to the source Stream. Will start printing 1, 2, 3
final subscription = stream.listen(print);
await Future(() {});

// Synchronously print the latest value
print(stream.value);

// Subscribe again later. This will print 3 because it receives the last
// emitted value.
final subscription2 = stream.listen(print);
await Future(() {});

// Stop emitting items from the source stream and close the underlying
// BehaviorSubject by cancelling all subscriptions.
subscription.cancel();
subscription2.cancel();

Implementation

ValueStream<T> shareValue() => publishValue().refCount();