# stream-operations

> Collection of stream operation utilities

Latest version **0.1.0** (published 2017-08-19) · MIT license · 0 weekly downloads

## Install

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

## 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.1.0 |
| Published | 2017-08-19 |
| First published | 2017-02-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 4.0.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Roel Berger |
| Maintainers | roelb |

## Links

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

## Dependencies (1)

- [lodash.assign](https://npm.io/package/lodash.assign.md) ^4.2.0

## Recent versions

- 0.1.0 (latest) — 2017-08-19
- 0.0.2 — 2017-02-22
- 0.0.1 — 2017-02-22

## README

stream-operations
=================

Collection of stream operations


Install
-------
```
npm install stream-operations --save
```

Usage
-----
```
var StreamOperations = require('stream-operations');
```

Operations
----------

### bufferWithTimeOrSize(time, size, options)
Buffer elements in an array and flush when either time or size limit is reached.   
Default flush after 1000ms or size 1000.

```
aReadable
.pipe(StreamOperations.bufferWithTimeOrSize(100, 100))  // Flush buffer after 100 milliseconds or when 100 objects are collected
...
```

### map(mapFunction, options)
Transform an object by calling the handler for every object

```
aReadable
.pipe(StreamOperations.map(d => d.id)) 
...
```

### filter(filterFunction, options)
Transform an object by calling the handler for every object

```
aReadable
.pipe(StreamOperations.filter(d => true)) 
...
```

### flatMap(mapFunction, options)
Transform an object by calling the handler for every object, which can be asynchronically. Either use the callback, or return a promise.

```
aReadable
.pipe(StreamOperations.flatMap((data, enc, done) => {
  done(null, data)
})) 
.pipe(StreamOperations.flatMap(data => {
  return new Promise((resolve, reject) => {
    resolve(data) // or reject
  })
}))
... 
```

### reduce(reduceFunction, initialValue, options)
Reduce a stream to a single value, which is sent through the stream when the previous link finishes.

```
aReadable
.pipe(StreamOperations.reduce((data, enc, previousValue) => previousValue++), 0) 
...
```

### each(eachFunction, options)
Do something for every object

```
aReadable
.pipe(StreamOperations.each(d => console.log(d))) 
...
```

Options
-------
Options can be anything provided by the Stream.Transform interface, by default: 
```
{ 
  objectMode: true
}
```

Extending
---------
When calling `StreamOperations.extend()` once in your code, node streams are extended with most of the stream operations.

**Use this with caution!**

While this is handy for speeding up your development and creates code with less clutter, don't use this in modules, since you are modifying the prototypes of streams.

```
readable
  .map(d => d)
  .filter(d => d)
  .pipe(Stream.Transform)
  .flatMap((d, enc, done) => { ... })
  .reduce(...)
  .each(...)
  .on('error', err => { ... })
```

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