Repository files navigation

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 theNode.js website.

If you want to guarantee a stable streams base, regardless of what version ofNode you, or the users of your libraries are using, usereadable-streamonly and avoid the"stream" module in Node-core, for background seethis blogpost.

As of version 2.0.0readable-stream uses semantic versioning.

v4.x.x ofreadable-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 includesmany new features.

v3.x.x ofreadable-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 inNode v9 andNode v10, as follows:

1. Error codes:nodejs/node#13310,nodejs/node#13291,nodejs/node#16589,nodejs/node#15042,nodejs/node#15665,#344
2. 'readable' have precedence over flowingnodejs/node#18994
3. make virtual methods errors consistentnodejs/node#18813
4. updated streams error handlingnodejs/node#18438
5. writable.end should return this.nodejs/node#18780
6. readable continues to read when push('')nodejs/node#18211
7. add custom inspect to BufferListnodejs/node#17907
8. always defer 'readable' with nextTicknodejs/node#17979

v2.x.x ofreadable-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.

You can swap yourrequire('stream') withrequire('readable-stream')without any changes, if you are just using one of the main classes andfunctions.

const{  Readable,  Writable,  Transform,  Duplex,  pipeline,  finished}=require('readable-stream')

Note thatrequire('stream') will returnStream, whilerequire('readable-stream') will returnReadable. We discourage usingwhatever is exported directly, but rather use one of the properties asshown in the example above.

You will need a bundler likebrowserify,webpack,parcel or similar. Polyfills are no longer required since version 4.2.0.

readable-stream is maintained by the Streams Working Group, whichoversees the development and maintenance of the Streams API withinNode.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 thisproject.
• Assisting in the implementation of stream providers within Node.js.
• Recommending versions ofreadable-stream to be included in Node.js.
• Messaging about the future of streams to give the community advancenotice of changes.

• Mathias Buus (@mafintosh) <mathiasbuus@gmail.com>
• Matteo Collina (@mcollina) <matteo.collina@gmail.com>
  • Release GPG key: 3ABC01543F22DD2239285CDD818674489FBC127E
• Robert Nagy (@ronag) <ronagy@icloud.com>
• Vincent Weevers (@vweevers) <mail@vincentweevers.nl>