# api-rate-limiter

> Rate limiter package for Express server API requests

Latest version **1.0.4** (published 2018-11-23) · GNU GENERAL PUBLIC LICENSE license · 0 weekly downloads

## Install

```sh
npm install api-rate-limiter
pnpm add api-rate-limiter
yarn add api-rate-limiter
bun add api-rate-limiter
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2018-11-23 |
| First published | 2018-11-03 |
| Weekly downloads | 0 |
| License | GNU GENERAL PUBLIC LICENSE |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 10.12.0 |
| Dependencies | 1 |
| Unpacked size | 49.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Anahit Vardanyan |
| Maintainers | anahit42 |
| Keywords | API, Limit, Rate, Rate Limiter, Rate Limiting |

## Links

- npm: https://www.npmjs.com/package/api-rate-limiter
- Repository: https://github.com/anahit42/api-rate-limiter
- Homepage: https://github.com/anahit42/api-rate-limiter#readme
- Issues: https://github.com/anahit42/api-rate-limiter/issues
- npm.io page: https://npm.io/package/api-rate-limiter

## Dependencies (1)

- [request-ip](https://npm.io/package/request-ip.md) 2.1.3

## Alternatives

- [promise-throttle](https://npm.io/package/promise-throttle.md) — 44.2K weekly downloads
- [@commercetools/sync-actions](https://npm.io/package/@commercetools/sync-actions.md) — 25.1K weekly downloads
- [cwait](https://npm.io/package/cwait.md) — 21.4K weekly downloads
- [@ledgerhq/hw-app-cosmos](https://npm.io/package/@ledgerhq/hw-app-cosmos.md) — 4.2K weekly downloads
- [@financial-times/o-loading](https://npm.io/package/@financial-times/o-loading.md) — 2.8K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2018-11-23
- 1.0.3 — 2018-11-05
- 1.0.2 — 2018-11-05
- 1.0.1 — 2018-11-05
- 1.0.0 — 2018-11-03

## README

# api-rate-limiter
Rate limiter package for Express server API requests

# API ✍

## api-rate-limiter API

### init(...)

|  Parameter                | Description                              | Required |  Default |
|---------------------------|------------------------------------------|----------|----------|
| payload.client            | RedisClient instance (promisified)       | ✔        | ✘        |
| payload.serverName        | API server name                          | ✔        | ✘        |

Sample: 

  ``` javascript
     const RateLimiter = require('api-rate-limiter')
     
     const Promise = require('bluebird')
     const redis = require('redis')
     
     Promise.promisifyAll(redis.RedisClient.prototype)
     const redisClient = redis.createClient()
     
     RateLimiter.init({ client: redisClient, serverName: 'code-mentor-api' })
  ```

RateLimiter should be initialized before initializing API routes.

##### Errors

|  Error name                         | Description                                                          |
|-------------------------------------|----------------------------------------------------------------------|
| RateLimiterInvalidRedisClientError  | Error thrown in case of invalid redis client                         |
| RateLimiterInvalidServerNameError   | Error thrown in case of invalid server name parameter                |

### preventRateLimitAbuse(...)

|  Parameter                             | Description                                | Required |  Default    |
|----------------------------------------|--------------------------------------------|----------|-------------|
| payload.maxNumberOfRequests            | Maximum allowed requests per time window   | ✔        | ✘           |
| payload.rateLimitWindowInSeconds       | Rate limit time window in seconds          | ✘        | 300 seconds |


Sample: 

  ``` javascript
  
    const express = require('express')
    const router = express.Router()
  
    const RateLimiter = require('api-rate-limiter')
  
    router.get('/',
      RateLimiter.preventRateLimitAbuse({ maxNumberOfRequests: 50,  rateLimitWindowInSeconds: 600 }),
      function (req, res, next) {
          ...request handler code
      })
  ```

##### Errors

|  Error name                         | Description                                                                 |
|-------------------------------------|-----------------------------------------------------------------------------|
| RateLimitExceededError              | Error passed to the next() middleware function in case of rate limit abuse  |
| RateLimiterMissingRedisClientError  | Error thrown in case of missing redis client for rate limiter               |
| RateLimiterMissingServerNameError   | Error thrown in case of missing server name for rate limiter                |


### HTTP Headers

|  Header                | Description                                                 |
|------------------------|-------------------------------------------------------------|
| X-RateLimit-Limit      | Requests permitted to make per time window                  |
| X-RateLimit-Remaining  | Requests remaining in the current time window               |
| X-RateLimit-Reset      | UNIX timestamp detailing when the rate limit will reset     |


Sample: 

```
X-RateLimit-Limit: 50
X-RateLimit-Remaining: 42
X-RateLimit-Reset: 1541169284467
```

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