# throttle

> Node.js Transform stream that passes data through at `n` bytes per second

Latest version **1.0.3** (published 2013-03-07) · 0 weekly downloads

## Install

```sh
npm install throttle
pnpm add throttle
yarn add throttle
bun add throttle
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2013-03-07 |
| First published | 2011-01-25 |
| Weekly downloads | 0 |
| TypeScript types | separate (@types/throttle) |
| Module format | CommonJS |
| Node | >= v0.8.0 |
| Dependencies | 2 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 188 |
| Author | Nathan Rajlich |
| Maintainers | TooTallNate, tootallnate |

## Links

- npm: https://www.npmjs.com/package/throttle
- Repository: https://github.com/TooTallNate/node-throttle
- npm.io page: https://npm.io/package/throttle

## Dependencies (2)

- [stream-parser](https://npm.io/package/stream-parser.md) >= 0.0.2
- [readable-stream](https://npm.io/package/readable-stream.md) >= 0.3.0

## Recent versions

- 1.0.3 (latest) — 2013-03-07
- 1.0.2 — 2013-02-26
- 1.0.1 — 2013-02-10
- 1.0.0 — 2013-02-09
- 0.0.1 — 2011-01-25

## README

node-throttle
=============
### Node.js Transform stream that passes data through at `n` bytes per second
[![Build Status](https://secure.travis-ci.org/TooTallNate/node-throttle.png)](http://travis-ci.org/TooTallNate/node-throttle)

This module offers a `Throttle` passthrough stream class, which allows you to
write data to it and it will be passed through in `n` bytes per second. It can
be useful for throttling HTTP uploads or to simulate reading from a file in
real-time, etc.


Installation
------------

``` bash
$ npm install throttle
```


Example
-------

Here's an example of throttling stdin at 1 byte per second and outputting the
data to stdout:

``` js
var Throttle = require('throttle');

// create a "Throttle" instance that reads at 1 bps
var throttle = new Throttle(1);

process.stdin.pipe(throttle).pipe(process.stdout);
```

We can see it in action with the `echo` command:

![](http://f.cl.ly/items/2h1I2Q0m3x1I2s2r2O3R/throttle.opt.gif)


API
---

  - [Throttle()](#throttle)

## Throttle()

The `Throttle` passthrough stream class is very similar to the node core
`stream.Passthrough` stream, except that you specify a `bps` "bytes per
second" option and data *will not* be passed through faster than the byte
value you specify.

You can invoke with just a `bps` Number and get the rest of the default
options. This should be more common:

``` js
process.stdin.pipe(new Throttle(100 * 1024)).pipe(process.stdout);
```

Or you can pass an `options` Object in, with a `bps` value specified along with
other options:

``` js
var t = new Throttle({ bps: 100 * 1024, chunkSize: 100, highWaterMark: 500 });
```

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