koa-ratelimit-lru
Rate limiter middleware backed by lru-cache for koa@2
Koa2
Middleware using async/await
, so you have to run in Node.js >= 7.0.0 with --harmony_async_await
or using babel
Installation
$ npm install koa-ratelimit-lru
Example
const ratelimit = const Koa = const app = // apply rate limit app // response middleware app app
Using one lru-cache
to store keys
const ratelimit = const Koa = const router = const app = const store = // Note: When you using custom store, duration and max would lose efficacy router router // response middleware app app
Options
duration
limit duration in milliseconds [1 minute]max
max length of cache [Infinity]store
custom lru-cache [new cache]prefix
custom prefix in lru-cache [ratelimit:]rate
max requests perid
[1000]id
id to compare requests [ip]body
custom throw body [json]headers
custom header namesremaining
remaining number of requests ['X-RateLimit-Remaining'
]reset
reset timestamp ['X-RateLimit-Reset'
]total
total number of requests ['X-RateLimit-Limit'
]
Responses
Example 200 with header fields:
HTTP/1.1 200 OK
X-RateLimit-Limit: 100
X-RateLimit-Remaining: 99
X-RateLimit-Reset: 1477978284
Content-Type: text/plain; charset=utf-8
Content-Length: 12
Date: Tue, 01 Nov 2016 05:13:11 GMT
Connection: keep-alive
Stuff!
Example 429 response:
HTTP/1.1 429 Too Many Requests
X-RateLimit-Remaining: 0
X-RateLimit-Reset: 1477978284
X-RateLimit-Limit: 100
Retry-After: 2
Content-Type: application/json; charset=utf-8
Content-Length: 50
Date: Tue, 01 Nov 2016 05:31:21 GMT
Connection: keep-alive
{"msg":"Rate limit exceeded, retry in 3 seconds."}
License
MIT