readable-stream

readable-stream

Node.js core streams for userland

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.

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.

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
• Node v13
• Node v14
• Node v15
• Node v16
• Node v17
• Node v18

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 and Node v10, as follows:

• 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
• 'readable' have precedence over flowing https://github.com/nodejs/node/pull/18994
• make virtual methods errors consistent https://github.com/nodejs/node/pull/18813
• updated streams error handling https://github.com/nodejs/node/pull/18438
• writable.end should return this. https://github.com/nodejs/node/pull/18780
• readable continues to read when push('') https://github.com/nodejs/node/pull/18211
• add custom inspect to BufferList https://github.com/nodejs/node/pull/17907
• 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.

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, webpack, parcel 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) <[e-mail]>
• Matteo Collina (@mcollina) <[e-mail]>
  • Release GPG key: 3ABC01543F22DD2239285CDD818674489FBC127E
• Robert Nagy (@ronag) <[e-mail]>
• Vincent Weevers (@vweevers) <[e-mail]>

Similar packages

Other packages similar to readable-stream

through2

Through2 is a tiny wrapper around Node.js streams.Transform that makes it easier to create transform streams. It is similar to readable-stream's Transform, but with a simpler API for most common use cases.

highland

Highland.js manages synchronous and asynchronous code easily, using nothing more than standard JavaScript and Node-like streams. It is more functional in nature compared to readable-stream and provides a higher level abstraction for handling streams.

stream-browserify

Stream-browserify is a browser-compatible version of Node.js' core stream module, similar to readable-stream. It allows the use of Node.js-style streams in the browser, but it is specifically designed to polyfill the native Node.js stream module for browser use.

bl

Buffer List (bl) is a storage object for collections of Node Buffers, which can be used with streams. Unlike readable-stream, it focuses on buffering and manipulating binary data rather than providing the stream API itself.