Skip to content

About

Append streams and data into one mother stream

Resources

Stars

15 stars

Watchers

1 watching

Forks

Latest commit

 

History

14 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Combine Streams

NPM version Build status Test coverage Dependency Status License Downloads Gittip

Basically a streams2 version of combined-stream. Allows you to combine streams as well as strings and buffers into a single stream. Why? I don't know. I just saw this repo and thought, "hey, this sucks because it's not streams2".

Example

combine()
.append(fs.createReadStream('file1.txt'))
.append(fs.createReadStream('file2.txt'))
.append(null)
.pipe(process.stdout)

API

Combine([options])

Creates a new Combine instance. options are passed to require('stream').PassThrough.

var combine = require('combine-streams')

combine.append(obj)

You can append:

  • A readable stream
  • A buffer
  • A string
  • A thunk that returns one of the above

To signify that you are done appending items, you must call combine.append(null) just like a readable stream's .push(null) implementation.

combine()
.append(fs.createReadStream('file1.txt'))
.append('End of the first file.')
.append(function (done) {
  done(null, fs.createReadStream('file2.txt'))
})
.append('End of the second file.')
.append(null)
.pipe(process.stdout)

combine.pipe(dest [, options])

combine itself is a readable stream, so you should probably use combine.pipe(dest).

About

Append streams and data into one mother stream

Resources

Stars

15 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages