koa-ratelimit
Rate limiter middleware for koa.
Installation
$ npm install koa-ratelimit
Example
With a Redis driver
const Koa = ;const ratelimit = ;const Redis = ;const app = ; // apply rate limit app; // response middleware app; app;console;
With a memory driver
const Koa = ;const ratelimit = ;const app = ; // apply rate limit const db = ; app; // response middleware app; app;console;
Options
driver
memory or redis [redis]db
redis connection instance or Map instance (memory)duration
of limit in milliseconds [3600000]errorMessage
custom error messageid
id to compare requests [ip]headers
custom header namesmax
max requests withinduration
[2500]disableHeader
set whether send theremaining, reset, total
headers [false]remaining
remaining number of requests ['X-RateLimit-Remaining'
]reset
reset timestamp ['X-RateLimit-Reset'
]total
total number of requests ['X-RateLimit-Limit'
]whitelist
if function returns true, middleware exits before limitingblacklist
if function returns true,403
error is thrown
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