koa-redis-ratelimit

Rate limiting middleware backed by Redis for Koa v2+, built for CrocodileJS.

Install

1npm install --save koa-redis-ratelimit

Usage

1import RateLimit from 'koa-redis-ratelimit';
2import redis from 'redis';
3import Koa from 'koa';
4
5const app = new Koa();
6
7// apply rate limit
8app.use(new Ratelimit({
9  db: redis.createClient(),
10  duration: 60000,
11  max: 100,
12  id: (ctx) => ctx.ip,
13  blacklist: [],
14  whitelist: []
15}).middleware);
16
17// response middleware
18app.use(ctx => {
19  ctx.body = 'Stuff!';
20});
21
22app.listen(3000);
23console.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:

1HTTP/1.1 200 OK
2X-Powered-By: koa
3X-RateLimit-Limit: 100
4X-RateLimit-Remaining: 99
5X-RateLimit-Reset: 1384377793
6Content-Type: text/plain; charset=utf-8
7Content-Length: 6
8Date: Wed, 13 Nov 2013 21:22:13 GMT
9Connection: keep-alive
10
11Stuff!

Example 429 response:

1HTTP/1.1 429 Too Many Requests
2X-Powered-By: koa
3X-RateLimit-Limit: 100
4X-RateLimit-Remaining: 0
5X-RateLimit-Reset: 1384377716
6Content-Type: text/plain; charset=utf-8
7Content-Length: 39
8Retry-After: 7
9Date: Wed, 13 Nov 2013 21:21:48 GMT
10Connection: keep-alive
11
12Rate limit exceeded, retry in 8 seconds

License

MIT