# node-stream

> Utilities for consuming, creating and manipulating node streams.

Latest version **1.7.0** (published 2017-07-28) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-stream
pnpm add node-stream
yarn add node-stream
bun add node-stream
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.7.0 |
| Published | 2017-07-28 |
| First published | 2016-05-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=0.12 |
| Dependencies | 5 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Stephen Zuniga |
| Maintainers | stezu |
| Keywords | streams, consume, create, manipulate, forEach, map, reduce, filter, pipeline |

## Links

- npm: https://www.npmjs.com/package/node-stream
- Repository: https://github.com/stezu/node-stream
- Homepage: https://github.com/stezu/node-stream#readme
- Issues: https://github.com/stezu/node-stream/issues
- npm.io page: https://npm.io/package/node-stream

## Dependencies (5)

- [lodash](https://npm.io/package/lodash.md) ^4.17.2
- [split2](https://npm.io/package/split2.md) ^2.1.0
- [through2](https://npm.io/package/through2.md) ^2.0.1
- [readable-stream](https://npm.io/package/readable-stream.md) ^2.3.3
- [stream-combiner2](https://npm.io/package/stream-combiner2.md) ^1.1.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

- 1.7.0 (latest) — 2017-07-28
- 1.6.0 — 2017-04-29
- 1.5.1 — 2017-04-22
- 1.5.0 — 2017-02-03
- 1.4.0 — 2016-12-22
- 1.3.1 — 2016-11-20
- 1.3.0 — 2016-11-20
- 1.2.0 — 2016-11-18
- 1.1.0 — 2016-10-25
- 1.0.0 — 2016-10-25
- 0.0.6 — 2016-05-19
- 0.0.5 — 2016-05-15
- 0.0.4 — 2016-05-15
- 0.0.3 — 2016-05-14
- 0.0.2 — 2016-05-13
- … 1 more at https://npm.io/package/node-stream/versions

## README

# Node-Stream

[![Build Status][1]][2] [![bitHound Score][3]][4] [![Test Coverage][5]][6]

[1]: https://travis-ci.org/stezu/node-stream.svg?branch=master
[2]: https://travis-ci.org/stezu/node-stream

[3]: https://www.bithound.io/github/stezu/node-stream/badges/score.svg
[4]: https://www.bithound.io/github/stezu/node-stream

[5]: https://coveralls.io/repos/github/stezu/node-stream/badge.svg?branch=master
[6]: https://coveralls.io/github/stezu/node-stream?branch=master

A [Stream](https://nodejs.org/api/stream.html) is a core interface in Node which is generally misunderstood. Since Node doesn't provide a simple API for them, they are very often misused. This library aims to resolve those problems by exposing a collection of array-like methods for working with Node Streams.

Every function in Node-Stream returns an instance of a *Streams3* Stream which means you'll be using the latest implementation of Streams. This library works with the latest Streams as well as Node 0.12 Streams.

```js
const nodeStream = require('node-stream');

// Get the 5 most recent posts by stezu
db.createReadStream()
    .pipe(nodeStream.where({ type: 'post', author: 'stezu' }))
    .pipe(nodeStream.sort((a, b) => a.id > b.id))
    .pipe(nodeStream.take(5))
    .pipe(nodeStream.stringify())
    .pipe(nodeStream.intersperse('\n'))
    .pipe(process.stdout);
```

## Install

You can install using npm:

```bash
npm install --save node-stream
```

You can then `require()` node-stream:

```js
const nodeStream = require('node-stream');
```

## Documentation

Documentation can be found at [http://stezu.github.io/node-stream/](http://stezu.github.io/node-stream/).

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