Inicio Explorar Axuda
Iniciar sesión
archz
/
node-stream-helpers
1
0
Fork 0
Ficheiros Incidencias 0 Pull Requests 0 Wiki

Sen descrición

Rama: doc/add-readme
Ramas Etiquetas
node-stream-hel...
ZIP TAR.GZ
Aurélien Richez 41bdc35a31 add readme %!s(int64=4) %!d(string=hai) anos
src 3c394840f1 fix grouped flushing an empty array %!s(int64=4) %!d(string=hai) anos
.gitignore 3204468d71 init %!s(int64=5) %!d(string=hai) anos
.prettierrc ebba18fd84 Add filter %!s(int64=5) %!d(string=hai) anos
package.json 4470e4323a base streams working %!s(int64=5) %!d(string=hai) anos
readme.md 41bdc35a31 add readme %!s(int64=4) %!d(string=hai) anos
tsconfig.json 3204468d71 init %!s(int64=5) %!d(string=hai) anos

readme.md

$PROJECT_NAME

What is $PROJECT_NAME ?

$PROJECT_NAME is a user friendly, type safe, wrapper around node streams. The API is a simplified version of scala's akka stream.

Node stream API has a few flaws in my view. It is tedious, verbose, error prone, badly typed... Yet, it does work. So stream-helper wraps node stream and provides a user friendly API on top of it, along with some useful functional helpers (filter, map...). This allows stream-helper to easily integrate with existing node streams, while providing simplercorrecly typed and fluent API.

What it is not

  • $PROJECT_NAME is not a port of akka stream. It does not aim to perfectly reproduce akka stream API.
  • $PROJECT_NAME is not a complete stream implementation. Implementing streams correctly with backpressure is tricky, so $PROJECT_NAME uses the nodejs stream api.

Getting started

  Source.fromReadableBuilder

The API is organised around three interfaces :

TODO : lazy evaluation

Source

This is the starting point of your stream. Think of it as a Readable in node streams.

As a matter of fact, you can build a source from a Readable with Source.fromReadableBuilder.