koa-ratelimit-promises v4.0.4

koa-ratelimit-promises

Rate limiter middleware for Koa (with Promises), built for CrocodileJS.

Install

npm install --save koa-ratelimit-promises

Usage

import RateLimit from 'koa-ratelimit-promises';
import redis from 'redis';
import Koa from 'koa';

const app = new Koa();

// apply rate limit
app.use(new Ratelimit({
  db: redis.createClient(),
  duration: 60000,
  max: 100,
  id: (ctx) => ctx.ip,
  blacklist: [],
  whitelist: []
}).middleware);

// response middleware
app.use(ctx => {
  ctx.body = 'Stuff!';
});

app.listen(3000);
console.log('listening on port 3000');

Options

• db - redis connection instance
• max - max requests within duration (default is 2500)
• duration - of limit in milliseconds (default is 3600000)
• id - id to compare requests ip
• whitelist - array of ids to whitelist
• blacklist - array of ids to blacklist

Responses

Example 200 with header fields:

HTTP/1.1 200 OK
X-Powered-By: koa
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: 1384377793
Content-Type: text/plain; charset=utf-8
Content-Length: 6
Date: Wed, 13 Nov 2013 21:22:13 GMT
Connection: keep-alive

Stuff!

Example 429 response:

HTTP/1.1 429 Too Many Requests
X-Powered-By: koa
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1384377716
Content-Type: text/plain; charset=utf-8
Content-Length: 39
Retry-After: 7
Date: Wed, 13 Nov 2013 21:21:48 GMT
Connection: keep-alive

Rate limit exceeded, retry in 8 seconds

License

MIT