1
|
# readable-stream
|
2
|
|
3
|
***Node-core v8.11.1 streams for userland*** [![Build Status](https://travis-ci.org/nodejs/readable-stream.svg?branch=master)](https://travis-ci.org/nodejs/readable-stream)
|
4
|
|
5
|
|
6
|
[![NPM](https://nodei.co/npm/readable-stream.png?downloads=true&downloadRank=true)](https://nodei.co/npm/readable-stream/)
|
7
|
[![NPM](https://nodei.co/npm-dl/readable-stream.png?&months=6&height=3)](https://nodei.co/npm/readable-stream/)
|
8
|
|
9
|
|
10
|
[![Sauce Test Status](https://saucelabs.com/browser-matrix/readable-stream.svg)](https://saucelabs.com/u/readable-stream)
|
11
|
|
12
|
```bash
|
13
|
npm install --save readable-stream
|
14
|
```
|
15
|
|
16
|
***Node-core streams for userland***
|
17
|
|
18
|
This package is a mirror of the Streams2 and Streams3 implementations in
|
19
|
Node-core.
|
20
|
|
21
|
Full documentation may be found on the [Node.js website](https://nodejs.org/dist/v8.11.1/docs/api/stream.html).
|
22
|
|
23
|
If you want to guarantee a stable streams base, regardless of what version of
|
24
|
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).
|
25
|
|
26
|
As of version 2.0.0 **readable-stream** uses semantic versioning.
|
27
|
|
28
|
# Streams Working Group
|
29
|
|
30
|
`readable-stream` is maintained by the Streams Working Group, which
|
31
|
oversees the development and maintenance of the Streams API within
|
32
|
Node.js. The responsibilities of the Streams Working Group include:
|
33
|
|
34
|
* Addressing stream issues on the Node.js issue tracker.
|
35
|
* Authoring and editing stream documentation within the Node.js project.
|
36
|
* Reviewing changes to stream subclasses within the Node.js project.
|
37
|
* Redirecting changes to streams from the Node.js project to this
|
38
|
project.
|
39
|
* Assisting in the implementation of stream providers within Node.js.
|
40
|
* Recommending versions of `readable-stream` to be included in Node.js.
|
41
|
* Messaging about the future of streams to give the community advance
|
42
|
notice of changes.
|
43
|
|
44
|
<a name="members"></a>
|
45
|
## Team Members
|
46
|
|
47
|
* **Chris Dickinson** ([@chrisdickinson](https://github.com/chrisdickinson)) <christopher.s.dickinson@gmail.com>
|
48
|
- Release GPG key: 9554F04D7259F04124DE6B476D5A82AC7E37093B
|
49
|
* **Calvin Metcalf** ([@calvinmetcalf](https://github.com/calvinmetcalf)) <calvin.metcalf@gmail.com>
|
50
|
- Release GPG key: F3EF5F62A87FC27A22E643F714CE4FF5015AA242
|
51
|
* **Rod Vagg** ([@rvagg](https://github.com/rvagg)) <rod@vagg.org>
|
52
|
- Release GPG key: DD8F2338BAE7501E3DD5AC78C273792F7D83545D
|
53
|
* **Sam Newman** ([@sonewman](https://github.com/sonewman)) <newmansam@outlook.com>
|
54
|
* **Mathias Buus** ([@mafintosh](https://github.com/mafintosh)) <mathiasbuus@gmail.com>
|
55
|
* **Domenic Denicola** ([@domenic](https://github.com/domenic)) <d@domenic.me>
|
56
|
* **Matteo Collina** ([@mcollina](https://github.com/mcollina)) <matteo.collina@gmail.com>
|
57
|
- Release GPG key: 3ABC01543F22DD2239285CDD818674489FBC127E
|
58
|
* **Irina Shestak** ([@lrlna](https://github.com/lrlna)) <shestak.irina@gmail.com>
|