Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/nodejs/readable-stream

Node-core streams for userland
https://github.com/nodejs/readable-stream

node nodejs

Last synced: 3 days ago
JSON representation

Node-core streams for userland

Awesome Lists containing this project

README 

        
# readable-stream



**_Node.js core streams for userland_**



[![npm status](https://img.shields.io/npm/v/readable-stream.svg)](https://npm.im/readable-stream)

[![node](https://img.shields.io/node/v/readable-stream.svg)](https://www.npmjs.org/package/readable-stream)

[![Node.js Build](https://github.com/nodejs/readable-stream/workflows/Node.js/badge.svg)](https://github.com/nodejs/readable-stream/actions?query=workflow%3ANode.js)

[![Browsers Build](https://github.com/nodejs/readable-stream/workflows/Browsers/badge.svg)](https://github.com/nodejs/readable-stream/actions?query=workflow%3ABrowsers)



```bash

npm install readable-stream

```



This package is a mirror of the streams implementations in Node.js 18.19.0.



Full documentation may be found on the [Node.js website](https://nodejs.org/dist/v18.19.0/docs/api/stream.html).



If you want to guarantee a stable streams base, regardless of what version of

Node you, or the users of your libraries are using, use **readable-stream** _only_ and avoid the _"stream"_ module in Node-core, for background see [this blogpost](http://r.va.gg/2014/06/why-i-dont-use-nodes-core-stream-module.html).



As of version 2.0.0 **readable-stream** uses semantic versioning.



## Version 4.x.x



v4.x.x of `readable-stream` is a cut from Node 18. This version supports Node 12, 14, 16 and 18, as well as evergreen browsers.

The breaking changes introduced by v4 are composed of the combined breaking changes in:

* [Node v12](https://nodejs.org/en/blog/release/v12.0.0/)

* [Node v13](https://nodejs.org/en/blog/release/v13.0.0/)

* [Node v14](https://nodejs.org/en/blog/release/v14.0.0/)

* [Node v15](https://nodejs.org/en/blog/release/v15.0.0/)

* [Node v16](https://nodejs.org/en/blog/release/v16.0.0/)

* [Node v17](https://nodejs.org/en/blog/release/v17.0.0/)

* [Node v18](https://nodejs.org/en/blog/release/v18.0.0/)



This also includes _many_ new features.



## Version 3.x.x



v3.x.x of `readable-stream` is a cut from Node 10. This version supports Node 6, 8, and 10, as well as evergreen browsers, IE 11 and latest Safari. The breaking changes introduced by v3 are composed by the combined breaking changes in [Node v9](https://nodejs.org/en/blog/release/v9.0.0/) and [Node v10](https://nodejs.org/en/blog/release/v10.0.0/), as follows:



1. Error codes: https://github.com/nodejs/node/pull/13310,

   https://github.com/nodejs/node/pull/13291,

   https://github.com/nodejs/node/pull/16589,

   https://github.com/nodejs/node/pull/15042,

   https://github.com/nodejs/node/pull/15665,

   https://github.com/nodejs/readable-stream/pull/344

2. 'readable' have precedence over flowing

   https://github.com/nodejs/node/pull/18994

3. make virtual methods errors consistent

   https://github.com/nodejs/node/pull/18813

4. updated streams error handling

   https://github.com/nodejs/node/pull/18438

5. writable.end should return this.

   https://github.com/nodejs/node/pull/18780

6. readable continues to read when push('')

   https://github.com/nodejs/node/pull/18211

7. add custom inspect to BufferList

   https://github.com/nodejs/node/pull/17907

8. always defer 'readable' with nextTick

   https://github.com/nodejs/node/pull/17979



## Version 2.x.x



v2.x.x of `readable-stream` is a cut of the stream module from Node 8 (there have been no semver-major changes from Node 4 to 8). This version supports all Node.js versions from 0.8, as well as evergreen browsers and IE 10 & 11.



# Usage



You can swap your `require('stream')` with `require('readable-stream')`

without any changes, if you are just using one of the main classes and

functions.



```js

const {

  Readable,

  Writable,

  Transform,

  Duplex,

  pipeline,

  finished

} = require('readable-stream')

```



Note that `require('stream')` will return `Stream`, while

`require('readable-stream')` will return `Readable`. We discourage using

whatever is exported directly, but rather use one of the properties as

shown in the example above.



## Usage In Browsers



You will need a bundler like [`browserify`](https://github.com/browserify/browserify#readme), [`webpack`](https://webpack.js.org/), [`parcel`](https://github.com/parcel-bundler/parcel#readme) or similar. Polyfills are no longer required since version 4.2.0.



# Streams Working Group



`readable-stream` is maintained by the Streams Working Group, which

oversees the development and maintenance of the Streams API within

Node.js. The responsibilities of the Streams Working Group include:



- Addressing stream issues on the Node.js issue tracker.

- Authoring and editing stream documentation within the Node.js project.

- Reviewing changes to stream subclasses within the Node.js project.

- Redirecting changes to streams from the Node.js project to this

  project.

- Assisting in the implementation of stream providers within Node.js.

- Recommending versions of `readable-stream` to be included in Node.js.

- Messaging about the future of streams to give the community advance

  notice of changes.






## Team Members



- **Mathias Buus** ([@mafintosh](https://github.com/mafintosh)) <[email protected]>

- **Matteo Collina** ([@mcollina](https://github.com/mcollina)) <[email protected]>

  - Release GPG key: 3ABC01543F22DD2239285CDD818674489FBC127E

- **Robert Nagy** ([@ronag](https://github.com/ronag)) <[email protected]>

- **Vincent Weevers** ([@vweevers](https://github.com/vweevers)) <[email protected]>