# reservoir-stream

> A streaming interface to reservoir sampling

Latest version **0.0.2** (published 2012-12-24) · MIT license · 0 weekly downloads

## Install

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

## 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.0.2 |
| Published | 2012-12-24 |
| First published | 2012-12-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | David Björklund |
| Maintainers | kesla |
| Keywords | reservoir, sampling |

## Links

- npm: https://www.npmjs.com/package/reservoir-stream
- Repository: https://github.com/kesla/reservoir-stream
- npm.io page: https://npm.io/package/reservoir-stream

## Dependencies (2)

- [through](https://npm.io/package/through.md) ~2.1.0
- [reservoir](https://npm.io/package/reservoir.md) ~0.1.1

## Recent versions

- 0.0.2 (latest) — 2012-12-24
- 0.0.1 — 2012-12-24

## README

#reservoir-stream[![build status](https://secure.travis-ci.org/kesla/reservoir-stream.png)](http://travis-ci.org/kesla/reservoir-stream)

A streaming interface to do [reservoir sampling](http://en.wikipedia.org/wiki/Reservoir_sampling) by using the great [reservoir](https://npmjs.org/package/reservoir) module.

## installation

```
npm install reservoir-stream
```

## demo/usage
```javascript
// use a reservoir size of 3
var stream = require('reservoir-stream')(3)

var inputStream.pipe(stream).pipe(outputStream)
// 3 random elements from the inputStream will be piped to the outputStream

```

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