# stream-to-promise

> Convert streams (readable or writable) to promises

Latest version **3.0.0** (published 2020-05-25) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install stream-to-promise
pnpm add stream-to-promise
yarn add stream-to-promise
bun add stream-to-promise
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 3.0.0 |
| Published | 2020-05-25 |
| First published | 2014-03-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/stream-to-promise) |
| Module format | CommonJS |
| Node | >= 10 |
| Dependencies | 3 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 139 |
| Author | Ben Drucker |
| Maintainers | bendrucker |
| Keywords | stream, promise |

## Links

- npm: https://www.npmjs.com/package/stream-to-promise
- Repository: https://github.com/bendrucker/stream-to-promise
- Issues: https://github.com/bendrucker/stream-to-promise/issues
- npm.io page: https://npm.io/package/stream-to-promise

## Dependencies (3)

- [any-promise](https://npm.io/package/any-promise.md) ~1.3.0
- [end-of-stream](https://npm.io/package/end-of-stream.md) ~1.4.1
- [stream-to-array](https://npm.io/package/stream-to-array.md) ~2.3.0

## Alternatives

- [byte-size](https://npm.io/package/byte-size.md) — 2.1M weekly downloads
- [speed-limiter](https://npm.io/package/speed-limiter.md) — 16.0K weekly downloads
- [@powersync/node](https://npm.io/package/@powersync/node.md) — 10.9K weekly downloads
- [@ledgerhq/coin-cardano](https://npm.io/package/@ledgerhq/coin-cardano.md) — 1.0K weekly downloads
- [@jayesol/jayeson.lib.streamfinder](https://npm.io/package/@jayesol/jayeson.lib.streamfinder.md) — 1.0K weekly downloads

## Recent versions

- 3.0.0 (latest) — 2020-05-25
- 2.2.0 — 2016-07-22
- 2.1.1 — 2016-06-21
- 2.1.0 — 2016-06-18
- 2.0.0 — 2016-06-18
- 1.1.1 — 2016-06-08
- 1.1.0 — 2015-12-06
- 1.0.4 — 2014-10-13
- 1.0.3 — 2014-10-13
- 1.0.2 — 2014-09-12
- 1.0.1 — 2014-08-19
- 1.0.0 — 2014-08-19
- 0.1.0 — 2014-05-29
- 0.0.5 — 2014-05-13
- 0.0.4 — 2014-05-13
- … 3 more at https://npm.io/package/stream-to-promise/versions

## README

# stream-to-promise [![Build Status](https://travis-ci.com/bendrucker/stream-to-promise.svg?branch=master)](https://travis-ci.com/bendrucker/stream-to-promise)

> Convert streams (readable or writable) to promises

## Installing

```sh
npm install --save stream-to-promise
```

## Examples

### Readable Streams

```js
streamToPromise(readableStream).then(function (buffer) {
  // buffer.length === 3
})
readableStream.emit('data', new Buffer())
readableStream.emit('data', new Buffer())
readableStream.emit('data', new Buffer())
readableStream.emit('end') // promise is resolved here
```

### Writable Streams

```js
streamToPromise(writableStream).then(function () {
  // resolves undefined
})
writableStream.write('data')
writableStream.end() // promise is resolved here
```

### Error Handling

```js
const err = new Error()
streamToPromise(stream).catch(function (error) {
  // error === err
})
stream.emit('error', err) // promise is rejected here
```

---
_Source: https://npm.io/package/stream-to-promise · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._