Rx Webstreams
Note: Very limited coverage right now Compared to rxJS, this lib has not nearly implemented enough at the time. But, all things that are added are inteded to be unit-tested well.
The good thing: each pice of this lib can be used separately with other webstreams found in any other library.
Because of the webstreams foundation they will likely be compatible.
In fact, I use many of these things implemented here myself,
for example the timerSource() package for generating example events for testing cli progress bars.
See here for details in the progress package: https://github.com/deno-library/progress/blob/master/tests/mod.test.ts
Description
A deno package by @codemonument with RxJS like functionality, but for webstreams. It provides a lot of predefined sources, targets and especially transforms!
Note, that the api is inspired by RxJS, but not related in any other way. This package is especially not based on RxJS!
Parts
- Sources: Predefined Readable Streams, like fileSource(), timerSource(), and more
- Transforms: Predefined Transport Streams, like map(), reduce(), and more
- Targets: Predefined Writable Streams, like fileTarget(), urlTarget(), and more
Usage
TODO: (Look at the tests in the meantime! They give you a very good idea of how to use those!)
Sources
- timerSource() - implemented ✅
- fileSource() - implemented ✅ (with simple Uint8Array Chunks)
- emitableSource() - implemented ✅ - allows to manually emit chunks into the controller of this readable stream
Transforms
- bytesToString() - implemented ✅ - converts uint8Array chunk to string
- stringToLines() - implemented ✅ - converts string chunks delimited by newline into one string line per chunk
- map() - planned
- reduce() - planned
- collect() - in consideration - collects chunks as array with options for: how long should chunks be collected? (specific time, until buffer full, specific count, etc.) and emits the resulting array as event (similar to rxjs buffer)
- multiplex() - in consideration => would multiplex different Readables by wrapping each chunk in an event which gets an id to uniquely identify the source readable in the resulting stream
Targets
- simpleCallbackTarget() - implemented ✅
- fileTarget() - planned
- urlTarget() - in consideration
Useful Links
- web.dev - Guide to Webstreams
- MDN - General Section on Webstreams
- MDN - Webstreams API Concepts
- MDN - Using Readable Streams
- MDN - Using Readable Byte Streams
- MDN - Using Writable Streams
- Interesting Guide to Webstreams on sitepen
Open Issues
Nothing currently
Decision Archive
Unified Convention for API Surface of rx_webstreams
Find unified convetion whether my sources, transforms and targets should be classes or functions!
- Pro: Classes can have extra methods (for example: starting/stopping a timer source, or emitting chunks manually)
- Contra: Can’t build an EmittableSource as extends ReadableStream (due to not being able to extract the controller in the constructor)
=> Must build EmittableSource as emittableSource.readble to access the underlying readable stream.
=> To have unified convention, a class-based system, all classes must then use a
.readableand.writableproperty => this is more ugly than accessing the source directly, like: new Source().readable.pipeThrough().pipeTo(new Target().writable)
Hints:
- Deno std/streams uses classes which directly implement ReadableStream, TransformStream or WritableStream.
- Delimiter (TransformStream): https://deno.land/std@0.163.0/streams/delimiter.ts?source
- Buffer (complete custom, with private readable and writable) https://deno.land/std@0.163.0/streams/buffer.ts?source
- Deno std/streams uses classes which directly implement ReadableStream, TransformStream or WritableStream.
=> Decision: Use functions, which return things that can directly be used with .pipeThrough() and .pipeTo(). This allow the implementer of these functions to reuse functionality implemented as classes by deno or custom classes from this package, by having a unified interface to the outside world.