Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

v4 launch details #472

Merged
merged 3 commits into from Jun 14, 2022
Merged

v4 launch details #472

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
54d0e5b
fixed review
mcollina May 24, 2022
f4c679f
Update README.md
mcollina Jun 4, 2022
54af20a
Update README.md
mcollina Jun 4, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 23 additions & 2 deletions README.md
View file
Open in desktop
Expand Up @@ -8,7 +8,7 @@
[![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 --save readable-stream
npm install readable-stream
```

This package is a mirror of the streams implementations in Node.js 18.0.0.
Expand All @@ -20,6 +20,20 @@ Node you, or the users of your libraries are using, use **readable-stream** _onl

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 by the combined breaking changes in
mcollina marked this conversation as resolved.
Show resolved Hide resolved
* [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 include _many_ new features.
mcollina marked this conversation as resolved.
Show resolved Hide resolved

## 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:
Expand Down Expand Up @@ -56,7 +70,14 @@ 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')
const {
Readable,
Writable,
Transform,
Duplex,
pipeline,
finished
} = require('readable-stream')
```

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