Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/feross/multistream
A stream that emits multiple other streams one after another (streams3)
https://github.com/feross/multistream
javascript multistream nodejs stream streams
Last synced: 18 days ago
JSON representation
A stream that emits multiple other streams one after another (streams3)
- Host: GitHub
- URL: https://github.com/feross/multistream
- Owner: feross
- License: mit
- Created: 2014-07-06T08:42:02.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-09-08T20:03:16.000Z (about 3 years ago)
- Last Synced: 2024-10-15T03:32:05.967Z (20 days ago)
- Topics: javascript, multistream, nodejs, stream, streams
- Language: JavaScript
- Homepage:
- Size: 97.7 KB
- Stars: 287
- Watchers: 9
- Forks: 26
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-nodejs-cn - multistream - (包 / 文件流)
- awesome-nodejs - multistream - A stream that emits multiple other streams one after another (streams2).  (Repository / Streams)
- awesome-nodejs-cn - multistream - **star:284** 将多个流合并到一个流中 (包 / 流)
- awesome-list - multistream
- awesome-nodejs - multistream - Combine multiple streams into a single stream. (Packages / Streams)
- awesome-nodejs - multistream - A stream that emits multiple other streams one after another (streams2) - ★ 146 (Streams)
- awesome-nodejs-streams - feross/multistream - A stream that emits multiple other streams one after another (streams2) (Modules)
- awesome-node - multistream - Combine multiple streams into a single stream. (Packages / Streams)
- awesome-nodejs-cn - multistream - (目录 / 流处理)
README
# multistream [![travis][travis-image]][travis-url] [![npm][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url] [![javascript style guide][standard-image]][standard-url]
[travis-image]: https://img.shields.io/travis/feross/multistream/master.svg
[travis-url]: https://travis-ci.org/feross/multistream
[npm-image]: https://img.shields.io/npm/v/multistream.svg
[npm-url]: https://npmjs.org/package/multistream
[downloads-image]: https://img.shields.io/npm/dm/multistream.svg
[downloads-url]: https://npmjs.org/package/multistream
[standard-image]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[standard-url]: https://standardjs.com
#### A stream that emits multiple other streams one after another (streams3)
[](https://saucelabs.com/u/multistream)
Simple, robust streams3 version of [combined-stream](https://www.npmjs.org/package/combined-stream). Allows you to combine multiple streams into a single stream. When the first stream ends, the next one starts, and so on, until all streams are consumed.
This module is used by [WebTorrent](http://webtorrent.io), specifically [create-torrent](https://github.com/feross/create-torrent).
### install
```
npm install multistream
```
### usage
Use `multistream` like this:
```js
var MultiStream = require('multistream')
var fs = require('fs')
var streams = [
fs.createReadStream(__dirname + '/numbers/1.txt'),
fs.createReadStream(__dirname + '/numbers/2.txt'),
fs.createReadStream(__dirname + '/numbers/3.txt')
]
new MultiStream(streams).pipe(process.stdout) // => 123
```
You can also create an object-mode stream with `MultiStream.obj(streams)`.
To lazily create the streams, wrap them in a function:
```js
var streams = [
fs.createReadStream(__dirname + '/numbers/1.txt'),
function () { // will be executed when the stream is active
return fs.createReadStream(__dirname + '/numbers/2.txt')
},
function () { // same
return fs.createReadStream(__dirname + '/numbers/3.txt')
}
]
new MultiStream(streams).pipe(process.stdout) // => 123
```
Alternatively, streams may be created by an asynchronous "factory" function:
```js
var count = 0
function factory (cb) {
if (count > 3) return cb(null, null)
count++
setTimeout(function () {
cb(null, fs.createReadStream(__dirname + '/numbers/' + count + '.txt'))
}, 100)
}
new MultiStream(factory).pipe(process.stdout) // => 123
```
### contributors
- [Feross Aboukhadijeh](http://feross.org)
- [Mathias Buus](https://github.com/mafintosh/)
- [Yuri Astrakhan](https://github.com/nyurik/)
### license
MIT. Copyright (c) [Feross Aboukhadijeh](http://feross.org).