# slow-stream

> A throttleable stream, for working in the slow-lane

Latest version **0.0.4** (published 2013-02-13) · MIT license · 0 weekly downloads

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

## Install

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

## Health

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

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.4 |
| Published | 2013-02-13 |
| First published | 2012-10-20 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | rvagg |
| Keywords | stream, throttle, slow, sloth, testing |

## Links

- npm: https://www.npmjs.com/package/slow-stream
- Repository: https://github.com/rvagg/node-slow-stream
- npm.io page: https://npm.io/package/slow-stream

## Alternatives

- [duck](https://npm.io/package/duck.md) — 4.2M weekly downloads
- [ava](https://npm.io/package/ava.md) — 560.2K weekly downloads
- [storybook-addon-module-mock](https://npm.io/package/storybook-addon-module-mock.md) — 71.7K weekly downloads
- [@ethereum-waffle/mock-contract](https://npm.io/package/@ethereum-waffle/mock-contract.md) — 40.0K weekly downloads
- [aws-elasticsearch-connector](https://npm.io/package/aws-elasticsearch-connector.md) — 37.4K weekly downloads

## Recent versions

- 0.0.4 (latest) — 2013-02-13
- 0.0.3 — 2012-12-03
- 0.0.2 — 2012-12-03
- 0.0.1 — 2012-10-28
- 0.0.0 — 2012-10-20

## README

# node-slow-stream

A throttleable stream, for working in the slow-lane; i.e. good for testing when you need things to slow down. Available in npm as *slow-stream*

## Example

```js
var fs = require('fs')
  , SlowStream = require('slow-stream')

fs.createReadStream('infile', { bufferSize: 64 })
  .pipe(new SlowStream({ maxWriteInterval: 5 }))
  .pipe(fs.createWriteStream('outfile'))
```

Throttling is performed on a per-write basis, so in this example the `ReadStream` from the file is writing 64-byte chunks at a time. The `SlowStream` is only allowing them through at a rate of one per 5ms.

Back-pressure is properly applied so if you're working with properly implemented streams you shouldn't run into memory issues.

## Contributing

Tests can be run with `npm test`. I'm more than happy to receive contributions so fork away!

## Copyright and licence

*Copyright (c) 2012 [Rod Vagg](https://github.com/rvagg) ([@rvagg](https://twitter.com/rvagg))*

Made available under the MIT licence:

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is furnished
to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

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