https://github.com/bredele/stream-then

⚡️ Make a stream thenable.
https://github.com/bredele/stream-then

async await promise stream then

Last synced: 9 days ago
JSON representation

⚡️ Make a stream thenable.

• Host: GitHub
• URL: https://github.com/bredele/stream-then
• Owner: bredele
• License: mit
• Created: 2017-03-12T01:00:17.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-12-06T20:55:14.000Z (about 7 years ago)
• Last Synced: 2024-12-01T11:12:01.146Z (27 days ago)
• Topics: async, await, promise, stream, then
• Language: JavaScript
• Homepage:
• Size: 6.84 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Stream-then

  > [![Build Status](https://travis-ci.org/bredele/stream-then.svg?branch=master)](https://travis-ci.org/bredele/stream-then)

  [![NPM](https://img.shields.io/npm/v/stream-then.svg)](https://www.npmjs.com/package/stream-then)

  [![Downloads](https://img.shields.io/npm/dm/stream-then.svg)](http://npm-stat.com/charts.html?package=stream-then)

  [![pledge](https://bredele.github.io/contributing-guide/community-pledge.svg)](https://github.com/bredele/contributing-guide/blob/master/community.md)

Create a thenable object from a readable stream.

  * **Concatenate stream buffers**: Collect and concatenate all of the buffers emitted by a readable stream. The stream is then resolved (or rejected) with a single buffer once ended.

  * **Async**: Perfect with asynchronous function using **async/await**.  

  * **Buffer mode**: Coerce result into a string by default. Stream-then also supports buffers and other things a stream can emit (see [documentation](https://github.com/bredele/stream-then/blob/master/test/then.js)).

## Usage

```js

const thenable = require('stream-then')

async function read() {

  try {

    const txt = await thenable(fileStream)

    // do something once file has been read

  } catch(err) {

    // do something if file

  }

}

```

Check out [examples](/test) for more information.

## Installation

```shell

npm install stream-then --save

```

[![NPM](https://nodei.co/npm/stream-then.png)](https://nodei.co/npm/stream-then/)

## Question

For questions and feedback please use our [twitter account](https://twitter.com/bredeleca). For support, bug reports and or feature requests please make sure to read our

community guideline and use the issue list of this repo and make sure it's not present yet in our reporting checklist.

## Contribution

Stream-then is an open source project and would not exist without its community. If you want to participate please make sure to read our guideline before making a pull request. If you have any stream-then related project, component or other let everyone know in our wiki.

## License

The MIT License (MIT)

Copyright (c) 2016 Olivier Wietrich

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.