readable-stream - npm Package Compare versions

Comparing version 3.0.0-rc.3 to 3.0.0

package.json

 {
   "name": "readable-stream",
-  "version": "3.0.0-rc.3",
+  "version": "3.0.0",
   "description": "Streams3, a user-land copy of the stream library from Node.js",
@@ -5,0 +5,0 @@ "main": "readable.js",

README.md

@@ -25,8 +25,61 @@ # readable-stream
 
+## Version 3.x.x
+
 v3.x.x of `readable-stream` supports Node 6, 8, and 10, as well as
-evergreen browsers and IE 11.
+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` supports all Node.js version from 0.8, as well as
 evergreen browsers and IE 10 & 11.
 
+### Big Thanks
+
+Cross-browser Testing Platform and Open Source <3 Provided by [Sauce Labs][sauce]
+
+# 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.
+
 # Streams Working Group
@@ -51,13 +104,10 @@
 
-* **Chris Dickinson** ([@chrisdickinson](https://github.com/chrisdickinson)) &lt;[e-mail]&gt;
-  - Release GPG key: 9554F04D7259F04124DE6B476D5A82AC7E37093B
 * **Calvin Metcalf** ([@calvinmetcalf](https://github.com/calvinmetcalf)) &lt;[e-mail]&gt;
   - Release GPG key: F3EF5F62A87FC27A22E643F714CE4FF5015AA242
-* **Rod Vagg** ([@rvagg](https://github.com/rvagg)) &lt;[e-mail]&gt;
-  - Release GPG key: DD8F2338BAE7501E3DD5AC78C273792F7D83545D
-* **Sam Newman** ([@sonewman](https://github.com/sonewman)) &lt;[e-mail]&gt;
 * **Mathias Buus** ([@mafintosh](https://github.com/mafintosh)) &lt;[e-mail]&gt;
-* **Domenic Denicola** ([@domenic](https://github.com/domenic)) &lt;[e-mail]&gt;
 * **Matteo Collina** ([@mcollina](https://github.com/mcollina)) &lt;[e-mail]&gt;
   - Release GPG key: 3ABC01543F22DD2239285CDD818674489FBC127E
 * **Irina Shestak** ([@lrlna](https://github.com/lrlna)) &lt;[e-mail]&gt;
+* **Yoshua Wyuts** ([@yoshuawuyts](https://github.com/yoshuawuyts)) &lt;[e-mail]&gt;
+
+[sauce]: https://saucelabs.com

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

112

increased by80.65%

Worsened metrics

Total package byte prevSize

109806

decreased by-0.79%

Number of package files

26

decreased by-3.7%

No dependency changes