Skip to content

tether/morph-stream

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Morph-Stream

Build Status NPM Downloads guidelines

Transform any value into a stream (even promises)! A morph stream is also memory efficient and destroys itself once the destination stream is closed.

Usage

const morph = require('morph')
const fs = require('fs')


// pipe string to response stream
morph('hello').pipe(res)

// pipe promise to response stream
morph(new Promise(resolve => {
  setTimeout(() => resolve('hello'), 1000)
})).pipe(res)


// pipe object to response stream
morph({
  beep: 'boop',
  foo: 'bar'
}).pipe(res)

// pipe stream
morph(fs.createReadStream(__dirname + '/sample.txt')).pipe(res)

When a promise is rejected, the error is propagated through the stream and it's your responsibility to catch it and process it.

Installation

npm install morph-stream --save

NPM

Question

For support, bug reports and or feature requests please make sure to read our community guidelines and use the issue list of this repo and make sure it's not present yet in our reporting checklist.

Contribution

The open source community is very important to us. If you want to participate to this repository, please make sure to read our guidelines before making any pull request. If you have any related project, please let everyone know in our wiki.

License

The MIT License (MIT)

Copyright (c) 2017 Tether Inc

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.

Releases

No releases published

Packages

No packages published