https://github.com/hybridables/promise2stream
Transform ES2015 Promise to Stream - specifically, Transform Stream using `through2`. Works in object mode by default, but you can pass options directly to the `through2` package.
https://github.com/hybridables/promise2stream
Last synced: 3 months ago
JSON representation
Transform ES2015 Promise to Stream - specifically, Transform Stream using `through2`. Works in object mode by default, but you can pass options directly to the `through2` package.
- Host: GitHub
- URL: https://github.com/hybridables/promise2stream
- Owner: hybridables
- License: mit
- Created: 2016-05-05T17:04:40.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2017-03-11T00:55:36.000Z (over 8 years ago)
- Last Synced: 2025-02-25T06:54:04.960Z (4 months ago)
- Language: JavaScript
- Homepage: http://www.tunnckocore.tk
- Size: 25.4 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# [promise2stream][author-www-url] [![npmjs.com][npmjs-img]][npmjs-url] [![The MIT License][license-img]][license-url] [![npm downloads][downloads-img]][downloads-url]
> Transform ES2015 Promise to Stream - specifically, Transform Stream using [through2][]. Works in object mode by default, but you can pass options directly to the [through2][] package.
[![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url]
## Install
```
npm i promise2stream --save
```
## Usage
> For more use-cases see the [tests](./test.js)
```js
const promise2stream = require('promise2stream')
```
### [promise2stream](index.js#L53)
> Transform a Promise `val` to transform stream.
**Params**
* `val` **{Promise}**: Some promise.
* `opts` **{Object}**: Options passed directly to [through2][].
* `returns` **{Stream}**
**Example**
```js
var promise2stream = require('promise2stream')
var promise = Promise.resolve(123)
var stream = promise2stream(promise)
stream
.on('data', function (val) {
console.log(val) // => 123
})
.once('error', console.error)
.once('end', function () {
console.log('end')
})
// or access the promise
stream.promise.then(function (val) {
console.log(val) // => 123
}, console.error)
// rejected promise fires `error` event
var rejectedPromise = Promise.reject(new Error('foo err'))
var stream = promise2stream(rejectedPromise)
stream.once('error', function (err) {
console.log(err) // => [Error: foo err]
})
```
## Related
* [always-stream](https://www.npmjs.com/package/always-stream): Create stream from any value - function, array, string, buffer, promise, number,… [more](https://www.npmjs.com/package/always-stream) | [homepage](https://github.com/hybridables/always-stream)
* [callback2stream](https://www.npmjs.com/package/callback2stream): Transform sync, async or generator function to Stream. Correctly handle errors. [homepage](https://github.com/hybridables/callback2stream)
* [limon](https://www.npmjs.com/package/limon): The pluggable JavaScript lexer. Limon = Lemon. | [homepage](https://github.com/limonjs/limon)
* [postcss](https://www.npmjs.com/package/postcss): Tool for transforming styles with JS plugins | [homepage](http://postcss.org/)
* [posthtml](https://www.npmjs.com/package/posthtml): HTML/XML processor | [homepage](https://github.com/posthtml/posthtml)
* [postjson](https://www.npmjs.com/package/postjson): Transforming JSON with plugins. | [homepage](https://github.com/postjson/postjson)
* [promise2thunk](https://www.npmjs.com/package/promise2thunk): Convert (transform) promise to thunk, just like was in co@3 | [homepage](https://github.com/tunnckocore/promise2thunk)
* [stream-from-promise](https://www.npmjs.com/package/stream-from-promise): Create streams from promises | [homepage](https://github.com/schnittstabil/stream-from-promise)
* [stream-to-promise](https://www.npmjs.com/package/stream-to-promise): Convert streams (readable or writable) to promises | [homepage](https://github.com/bendrucker/stream-to-promise)
* [through2](https://www.npmjs.com/package/through2): A tiny wrapper around Node streams2 Transform to avoid explicit subclassing noise | [homepage](https://github.com/rvagg/through2)
* [thunk2promise](https://www.npmjs.com/package/thunk2promise): Transform or convert thunk to Bluebird Promise. | [homepage](https://github.com/tunnckocore/thunk2promise)
* [value2stream](https://www.npmjs.com/package/value2stream): Transform any value to stream. Create stream from any value - string,… [more](https://www.npmjs.com/package/value2stream) | [homepage](https://github.com/hybridables/value2stream)
## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/hybridables/promise2stream/issues/new).
But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines.
## [Charlike Make Reagent](http://j.mp/1stW47C) [![new message to charlike][new-message-img]][new-message-url] [![freenode #charlike][freenode-img]][freenode-url]
[![tunnckoCore.tk][author-www-img]][author-www-url] [![keybase tunnckoCore][keybase-img]][keybase-url] [![tunnckoCore npm][author-npm-img]][author-npm-url] [![tunnckoCore twitter][author-twitter-img]][author-twitter-url] [![tunnckoCore github][author-github-img]][author-github-url]
[through2]: https://github.com/rvagg/through2
[npmjs-url]: https://www.npmjs.com/package/promise2stream
[npmjs-img]: https://img.shields.io/npm/v/promise2stream.svg?label=promise2stream
[license-url]: https://github.com/hybridables/promise2stream/blob/master/LICENSE
[license-img]: https://img.shields.io/npm/l/promise2stream.svg
[downloads-url]: https://www.npmjs.com/package/promise2stream
[downloads-img]: https://img.shields.io/npm/dm/promise2stream.svg
[codeclimate-url]: https://codeclimate.com/github/hybridables/promise2stream
[codeclimate-img]: https://img.shields.io/codeclimate/github/hybridables/promise2stream.svg
[travis-url]: https://travis-ci.org/hybridables/promise2stream
[travis-img]: https://img.shields.io/travis/hybridables/promise2stream/master.svg
[coveralls-url]: https://coveralls.io/r/hybridables/promise2stream
[coveralls-img]: https://img.shields.io/coveralls/hybridables/promise2stream.svg
[david-url]: https://david-dm.org/hybridables/promise2stream
[david-img]: https://img.shields.io/david/hybridables/promise2stream.svg
[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[author-www-url]: http://www.tunnckocore.tk
[author-www-img]: https://img.shields.io/badge/www-tunnckocore.tk-fe7d37.svg
[keybase-url]: https://keybase.io/tunnckocore
[keybase-img]: https://img.shields.io/badge/keybase-tunnckocore-8a7967.svg
[author-npm-url]: https://www.npmjs.com/~tunnckocore
[author-npm-img]: https://img.shields.io/badge/npm-~tunnckocore-cb3837.svg
[author-twitter-url]: https://twitter.com/tunnckoCore
[author-twitter-img]: https://img.shields.io/badge/[email protected]
[author-github-url]: https://github.com/tunnckoCore
[author-github-img]: https://img.shields.io/badge/[email protected]
[freenode-url]: http://webchat.freenode.net/?channels=charlike
[freenode-img]: https://img.shields.io/badge/freenode-%23charlike-5654a4.svg
[new-message-url]: https://github.com/tunnckoCore/ama
[new-message-img]: https://img.shields.io/badge/ask%20me-anything-green.svg