https://github.com/mcollina/callback-stream

A pipeable stream that calls your callback
https://github.com/mcollina/callback-stream

Last synced: about 1 month ago
JSON representation

A pipeable stream that calls your callback

• Host: GitHub
• URL: https://github.com/mcollina/callback-stream
• Owner: mcollina
• Created: 2013-05-10T18:15:32.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2020-12-17T11:54:40.000Z (about 4 years ago)
• Last Synced: 2024-11-01T12:42:23.481Z (about 2 months ago)
• Language: JavaScript
• Homepage:
• Size: 114 KB
• Stars: 7
• Watchers: 3
• Forks: 2
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
CallbackStream

=====

[![Build

Status](https://travis-ci.org/mcollina/callback-stream.png)](https://travis-ci.org/mcollina/callback-stream)

It is a safe variant of the

[concat-stream](https://github.com/maxogden/node-concat-stream)

package that _will always return an array_.

It does everything callback-stream does, minus the concatenation.

In fact, it just callbacks you with an array containing your

good stuff.

It is based on the Stream 2 API, but it also works on node v0.8.

It also support Stream 3, which is bundled with node v0.12 and iojs.

## Installation

```

npm install callback-stream --save

```

## Pipe usage

```js

var callback = require('callback-stream')

var fs = require('fs')

var read = fs.createReadStream('readme.md')

var write = callback(function (err, data) {

  console.log(err, data)

})

read.pipe(write)

```

## Object mode usage

```

var callback = require('callback-stream')

var write = callback.obj(function (err, data) {

  // this will print ['hello', 'world']

  console.log(data)

})

write.write('hello')

write.write('world')

write.end()

```

## Contributing to CallbackStream

* Check out the latest master to make sure the feature hasn't been

  implemented or the bug hasn't been fixed yet

* Check out the issue tracker to make sure someone already hasn't

  requested it and/or contributed it

* Fork the project

* Start a feature/bugfix branch

* Commit and push until you are happy with your contribution

* Make sure to add tests for it. This is important so I don't break it

  in a future version unintentionally.

## LICENSE - "MIT License"

Copyright (c) 2013-2015 Matteo Collina, http://matteocollina.com

Permission is hereby granted, free of charge, to any person

obtaining a copy of this software and associated documentation

files (the "Software"), to deal in the Software without

restriction, including without limitation the rights to use,

copy, modify, merge, publish, distribute, sublicense, and/or sell

copies of the Software, and to permit persons to whom the

Software is furnished to do so, subject to the following

conditions:

The above copyright notice and this permission notice shall be

included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,

EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES

OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND

NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT

HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,

WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING

FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR

OTHER DEALINGS IN THE SOFTWARE.