stream_transform 1.0.0

  • Readme
  • Changelog
  • Example
  • Installing
  • 97

Extension methods on Stream adding common transform operators.

Operators #

asyncMapBuffer, asyncMapSample, concurrentAsyncMap #

Alternatives to asyncMap. asyncMapBuffer prevents the callback from overlapping execution and collects events while it is executing. asyncMapSample prevents overlapping execution and discards events while it is executing. concurrentAsyncMap allows overlap and removes ordering guarantees for higher throughput.

Like asyncMap but events are buffered in a List until previous events have been processed rather than being called for each element individually.

asyncWhere #

Like where but allows an asynchronous predicate.

audit #

Waits for a period of time after receiving a value and then only emits the most recent value.

buffer #

Collects values from a source stream until a trigger stream fires and the collected values are emitted.

combineLatest, combineLatestAll #

Combine the most recent event from multiple streams through a callback or into a list.

debounce, debounceBuffer #

Prevents a source stream from emitting too frequently by dropping or collecting values that occur within a given duration.

followedBy #

Appends the values of a stream after another stream finishes.

merge, mergeAll #

Interleaves events from multiple streams into a single stream.

scan #

Scan is like fold, but instead of producing a single value it yields each intermediate accumulation.

startWith, startWithMany, startWithStream #

Prepend a value, an iterable, or a stream to the beginning of another stream.

switchMap, switchLatest #

Flatten a Stream of Streams into a Stream which forwards values from the most recent Stream

takeUntil #

Let values through until a Future fires.

tap #

Taps into a single-subscriber stream to react to values as they pass, without being a real subscriber.

throttle #

Blocks events for a duration after an event is successfully emitted.

whereType #

Like Iterable.whereType for a stream.

Getting a StreamTransformer instance

It may be useful to pass an instance of StreamTransformer so that it can be used with stream.transform calls rather than reference the specific operator in place. Any operator on Stream that returns a Stream can be modeled as a StreamTransformer using the fromBind constructor.

final debounce = StreamTransformer.fromBind(
    (s) => s.debounce(const Duration(milliseconds: 100)));

1.0.0 #

  • Remove the top level methods and retain the extensions only.

0.0.20 #

  • Add extension methods for most transformers. These should be used in place of the current methods. All current implementations are deprecated and will be removed in the next major version bump.

    • Migrating typical use: Instead of stream.transform(debounce(Duration(seconds: 1))) use stream.debounce(Duration(seconds: 1)).
    • To migrate a usage where a StreamTransformer instance is stored or passed see "Getting a StreamTransformer instance" on the README.
  • The map and chainTransformers utilities are no longer useful with the new patterns so they are deprecated without a replacement. If you still have a need for them they can be replicated with StreamTransformer.fromBind:

    // Replace `map(convert)`
    StreamTransformer.fromBind((s) => s.map(convert));
    
    // Replace `chainTransformers(first, second)`
    StreamTransformer.fromBind((s) => s.transform(first).transform(second));
    

0.0.19 #

  • Add asyncMapSample transform.

0.0.18 #

  • Internal cleanup. Passed "trigger" streams or futures now allow <void> generic type rather than an implicit dynamic>

0.0.17 #

  • Add concrete types to the onError callback in tap.

0.0.16+1 #

  • Remove usage of Set literal which is not available before Dart 2.2.0

0.0.16 #

  • Allow a combine callback to return a FutureOr<T> in scan. There are no behavior changes for synchronous callbacks. Potential breaking change In the unlikely situation where scan was used to produce a Stream<Future> inference may now fail and require explicit generic type arguments.
  • Add combineLatest.
  • Add combineLatestAll.

0.0.15 #

  • Add whereType.

0.0.14+1 #

  • Allow using non-dev Dart 2 SDK.

0.0.14 #

  • asyncWhere will now forward exceptions thrown by the callback through the result Stream.
  • Added concurrentAsyncMap.

0.0.13 #

  • mergeAll now accepts an Iterable<Stream> instead of only List<Stream>.

0.0.12 #

  • Add chainTransformers and map for use cases where StreamTransformer instances are stored as variables or passed to methods other than transform.

0.0.11 #

  • Renamed concat as followedBy to match the naming of Iterable.followedBy. concat is now deprecated.

0.0.10 #

  • Updates to support Dart 2.0 core library changes (wave 2.2). See issue 31847 for details.

0.0.9 #

  • Add asyncMapBuffer.

0.0.8 #

  • Add takeUntil.

0.0.7 #

  • Bug Fix: Streams produced with scan and switchMap now correctly report isBroadcast.
  • Add startWith, startWithMany, and startWithStream.

0.0.6 #

  • Bug Fix: Some transformers did not correctly add data to all listeners on broadcast streams. Fixed for throttle, debounce, asyncWhere and audit.
  • Bug Fix: Only call the tap data callback once per event rather than once per listener.
  • Bug Fix: Allow canceling and re-listening to broadcast streams after a merge transform.
  • Bug Fix: Broadcast streams which are buffered using a single-subscription trigger can be canceled and re-listened.
  • Bug Fix: Buffer outputs one more value if there is a pending trigger before the trigger closes.
  • Bug Fix: Single-subscription streams concatted after broadcast streams are handled correctly.
  • Use sync StreamControllers for forwarding where possible.

0.0.5 #

  • Bug Fix: Allow compiling switchLatest with Dart2Js.
  • Add asyncWhere: Like where but allows an asynchronous predicate.

0.0.4 #

  • Add scan: fold which returns intermediate values
  • Add throttle: block events for a duration after emitting a value
  • Add audit: emits the last event received after a duration

0.0.3 #

  • Add tap: React to values as they pass without being a subscriber on a stream
  • Add switchMap and switchLatest: Flatten a Stream of Streams into a Stream which forwards values from the most recent Stream

0.0.2 #

  • Add concat: Appends streams in series
  • Add merge and mergeAll: Interleaves streams

0.0.1 #

  • Initial release with the following utilities:
    • buffer: Collects events in a List until a trigger stream fires.
    • debounce, debounceBuffer: Collect or drop events which occur closer in time than a given duration.

example/main.dart

// Copyright (c) 2019, the Dart project authors.  Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.

import 'dart:html';

import 'package:stream_transform/stream_transform.dart';

void main() {
  var firstInput = document.querySelector('#first_input') as InputElement;
  var secondInput = document.querySelector('#second_input') as InputElement;
  var output = document.querySelector('#output');

  _inputValues(firstInput)
      .combineLatest(_inputValues(secondInput),
          (first, second) => 'First: $first, Second: $second')
      .tap((v) {
    print('Saw: $v');
  }).forEach((v) {
    output.text = v;
  });
}

Stream<String> _inputValues(InputElement element) => element.onKeyUp
    .debounce(const Duration(milliseconds: 100))
    .map((_) => element.value);

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  stream_transform: ^1.0.0

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:stream_transform/stream_transform.dart';
  
Popularity:
Describes how popular the package is relative to other packages. [more]
95
Health:
Code health derived from static analysis. [more]
99
Maintenance:
Reflects how tidy and up-to-date the package is. [more]
100
Overall:
Weighted score of the above. [more]
97
Learn more about scoring.

We analyzed this package on Nov 21, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

  • Dart: 2.6.1
  • pana: 0.12.21

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:stream_transform/stream_transform.dart.

Health issues and suggestions

Document public APIs. (-1 points)

1 out of 1 API elements have no dartdoc comment.Providing good documentation for libraries, classes, functions, and other API elements improves code readability and helps developers find and use your API.

Dependencies

Package Constraint Resolved Available
Direct dependencies
Dart SDK >=2.6.0 <3.0.0
Dev dependencies
pedantic ^1.5.0
test ^1.0.0