Simple streams API for streamline.js
JavaScript
Switch branches/tags
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
test
.gitignore
.npmignore
.travis.yml
API.md
README.md
build.js
index.js
package.json

README.md

Warning: this module is the original stream API for streamline.js. It is now superseeded by the ez-streams package which provide a much richer API.

You can nevertheless use this module directly if you are only interested by the low level wrappers around node streams.

This module provides:

  • a generic ReadableStream wrapper with an asynchronous stream.read(_[, len]) method.
  • a generic WritableStream wrapper with an asynchronous stream.write(_, buf[, encoding]) method.
  • wrappers for HTTP and TCP request and response objects (client and server).

See the API reference for details.

More information

The following blog articles give background information on this API design: