observables-with-streams
v0.6.1
Published
A library of observables built with streams
Downloads
45
Readme
Observables with Streams
A library for observables built with WHATWG streams. This library is inspired by ReactiveX’s operators and implements a subset of them using streams.
npm install --save observables-with-streamsThe goal of this library is to implement observables making as much use of the platform as possible and being highly tree-shakeable.
Example
<!DOCTYPE html>
<button id="dec">-</button>
<span id="counter">0</span>
<button id="inc">+</button>
<script type="module">
import * as ows from "observables-with-streams";
ows.merge(
ows.fromEvent(
document.querySelector("#dec")
"click"
).pipeThrough(ows.map(() => -1)),
ows.fromEvent(
document.querySelector("#inc")
"click"
).pipeThrough(ows.map(() => 1))
)
.pipeThrough(
ows.scan((v0, v1) => v0 + v1, 0)
)
.pipeTo(
ows.subscribe(
v => document.querySelector("#counter").textContent = v
)
);
</script>Documentation
The (somewhat lacking) documentation for this library is hosted at https://observables-with-streams.surma.technology
Caveats
While most browsers have partial support of streams in stable, this library makes heavy use of TransformStreams, which are currently not well supported. Until browsers catch up, I can recommend Mattias Buelens' web-streams-polyfill.
For a good primer about streams, read this blog post by Jake Archibald (he is aware the title hasn’t aged well).
License Apache 2.0