npm

Need private packages and team management tools?Check out npm Orgs. »

scripe

1.0.0 • Public • Published

Scripe

Pipe a scream into a Stream.Writable.

  • Handles backpressure
  • Forwards error to the writer
  • Only supports piping to a single writer (convert to a Stream.Readable using screamable if you want to pipe to multiple destinations)
  • Automatic cleanup if the writer prematurely dies

Example

var pull = require('scream')
var pipe = require('scripe')
 
var read = pull(function () {
  yield 'hello'
  yield 'world'
})
 
pipe(read, fs.createWriteStream('hello.txt'))
.on('error', function (err) {
  console.error(err.stack)
})
.on('finish', function () {
  console.log('done!')
})

API

writer = pipe(read, writer)

Pipes data from read to writer and returns the writer for chaining.

License

The MIT License (MIT)

Copyright (c) 2014 Jonathan Ong me@jongleberry.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.

Keywords

none

install

npm i scripe

Downloadsweekly downloads

2

version

1.0.0

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
  • avatar
  • avatar
  • avatar
  • avatar
Report a vulnerability