File: readme.markdown

package info (click to toggle)
node-stream-browserify 3.0.0-3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 128 kB
  • sloc: javascript: 137; makefile: 2
file content (32 lines) | stat: -rw-r--r-- 1,167 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# stream-browserify

the stream module from node core, for browsers!

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.

[![build status](https://secure.travis-ci.org/browserify/stream-browserify.svg?branch=master)](http://travis-ci.org/browserify/stream-browserify)

## Install

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.

But if none of those apply, with [npm](https://npmjs.org) do:

```bash
npm install stream-browserify
```

## API

Consult the node core
[documentation on streams](http://nodejs.org/docs/latest/api/stream.html).

## Browser Support

Cross-browser testing generously provided by [Sauce Labs](https://saucelabs.com).

[![Sauce Test Status](https://saucelabs.com/browser-matrix/stream-browserify.svg)](https://saucelabs.com/u/stream-browserify)

## License

[MIT](./LICENSE)