| 1 | # stream-browserify
|
| 2 |
|
| 3 | the stream module from node core, for browsers!
|
| 4 |
|
| 5 | This module uses [`readable-stream`](https://github.com/nodejs/readable-stream), with additions for compatibility with npm packages that use old Node.js stream APIs.
|
| 6 |
|
| 7 | [](http://travis-ci.org/browserify/stream-browserify)
|
| 8 |
|
| 9 | ## Install
|
| 10 |
|
| 11 | You usually do not have to install `stream-browserify` yourself! If your code runs in Node.js, `stream` is built in, or `readable-stream` can be used. If your code runs in the browser, bundlers like [browserify](https://github.com/browserify/browserify) also include the `stream-browserify` module.
|
| 12 |
|
| 13 | But if none of those apply, with [npm](https://npmjs.org) do:
|
| 14 |
|
| 15 | ```bash
|
| 16 | npm install stream-browserify
|
| 17 | ```
|
| 18 |
|
| 19 | ## API
|
| 20 |
|
| 21 | Consult the node core
|
| 22 | [documentation on streams](http://nodejs.org/docs/latest/api/stream.html).
|
| 23 |
|
| 24 | ## Browser Support
|
| 25 |
|
| 26 | Cross-browser testing generously provided by [Sauce Labs](https://saucelabs.com).
|
| 27 |
|
| 28 | [](https://saucelabs.com/u/stream-browserify)
|
| 29 |
|
| 30 | ## License
|
| 31 |
|
| 32 | [MIT](./LICENSE)
|