# promise-ratelimit

> Rate limiting (throttling) implementation for ES6 Promises

Latest version **0.0.3** (published 2016-10-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install promise-ratelimit
pnpm add promise-ratelimit
yarn add promise-ratelimit
bun add promise-ratelimit
```

## 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.3 |
| Published | 2016-10-15 |
| First published | 2015-12-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Anna Henningsen |
| Maintainers | addaleax |

## Links

- npm: https://www.npmjs.com/package/promise-ratelimit
- Repository: https://github.com/addaleax/promise-ratelimit
- Issues: https://github.com/addaleax/promise-ratelimit/issues
- npm.io page: https://npm.io/package/promise-ratelimit

## Recent versions

- 0.0.3 (latest) — 2016-10-15
- 0.0.2 — 2015-12-17

## README

promise-ratelimit
============

[![NPM Version](https://img.shields.io/npm/v/promise-ratelimit.svg?style=flat)](https://npmjs.org/package/promise-ratelimit)
[![NPM Downloads](https://img.shields.io/npm/dm/promise-ratelimit.svg?style=flat)](https://npmjs.org/package/promise-ratelimit)
[![Build Status](https://travis-ci.org/addaleax/promise-ratelimit.svg?style=flat&branch=master)](https://travis-ci.org/addaleax/promise-ratelimit?branch=master)
[![Coverage Status](https://coveralls.io/repos/addaleax/promise-ratelimit/badge.svg?branch=master)](https://coveralls.io/r/addaleax/promise-ratelimit?branch=master)
[![Dependency Status](https://david-dm.org/addaleax/promise-ratelimit.svg?style=flat)](https://david-dm.org/addaleax/promise-ratelimit)
[![devDependency Status](https://david-dm.org/addaleax/promise-ratelimit/dev-status.svg?style=flat)](https://david-dm.org/addaleax/promise-ratelimit#info=devDependencies)

Rate limiting (throttling) implementation for Promises on Node.js

Install:
`npm install promise-ratelimit`

Limit frequency of promise fulfilling:

```javascript
var throttle = require('promise-ratelimit')(2000); /* rateInMilliseconds */

var startTime = Date.now();

for (var i = 0; i < 10; i++) {
	throttle().then(function() { console.log(Date.now() - startTime); });
}

// example output:
// 11
// 2007
// 4007
// 6008
// 8011
// 10014
// 12016
// 14018
// 16020
// 18022
```

License
===

MIT

Note: [q-ratelimit](https://github.com/addaleax/q-ratelimit) and
[promise-ratelimit](https://github.com/addaleax/promise-ratelimit) are
sister modules based on the same original code.

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