# promising-streams

> Streams with support for promise internals

Latest version **0.6.0** (published 2015-09-11) · MIT license · 0 weekly downloads

## Install

```sh
npm install promising-streams
pnpm add promising-streams
yarn add promising-streams
bun add promising-streams
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.0 |
| Published | 2015-09-11 |
| First published | 2015-07-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Sam Newman |
| Maintainers | sonewman |
| Keywords | streams, promises |

## Links

- npm: https://www.npmjs.com/package/promising-streams
- Repository: https://github.com/sonewman/a-streams-promise
- Homepage: https://github.com/sonewman/a-streams-promise#readme
- Issues: https://github.com/sonewman/a-streams-promise/issues
- npm.io page: https://npm.io/package/promising-streams

## Dependencies (5)

- [xtend](https://npm.io/package/xtend.md) ^4.0.0
- [consec](https://npm.io/package/consec.md) ^1.0.2
- [promise](https://npm.io/package/promise.md) ^7.0.3
- [macchiato](https://npm.io/package/macchiato.md) ^4.2.1
- [readable-stream](https://npm.io/package/readable-stream.md) ^2.0.1

## 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

- 0.6.0 (latest) — 2015-09-11
- 0.5.0 — 2015-09-11
- 0.4.0 — 2015-09-11
- 0.3.0 — 2015-07-29
- 0.2.0 — 2015-07-28
- 0.1.1 — 2015-07-21
- 0.1.0 — 2015-07-18

## README

# Promising-Streams

Create Streams which utilise promises for their internal methods.

### Usage

#### Readable([options,] read)

Readable can be called as a method or instantiated, either way it returns a new 
instance of a **ReadablePromiseStream**.

#### Examples
```javascript
var readable = require('promising-streams').Readable

var arr = ['a', 'b', 'c', 'd', 'e'];

readable(() => Promise.resolve(arr.shift() || null))
.pipe(someOtherStream);
```

This basically sets the streams internal `_read` method to call the
supplied `read` callback. The only difference to regular streams is
that the callback is set to `__read` rather than `_read`

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