v2.0.0 - API CHANGE - Change remaining to include current call instead of decreasing it. Decreasing caused an off-by-one problem and caller could not distinguish between last legit call and a rejected call.
Requirements
Redis 2.6.12+
Node 6.0.0+
Installation
$ npm install ratelimiter
Example
Example Connect middleware implementation limiting against a user._id:
var id = req.user._id;var limit = new Limiter({ id: id, db: db });limit.get(function(err, limit){ if (err) return next(err); res.set('X-RateLimit-Limit', limit.total); res.set('X-RateLimit-Remaining', limit.remaining - 1); res.set('X-RateLimit-Reset', limit.reset); // all good debug('remaining %s/%s %s', limit.remaining - 1, limit.total, id); if (limit.remaining) return next(); // not good var delta
Result Object
total - max value
remaining - number of calls left in current duration without decreasing current get
reset - time since epoch in seconds at which the rate limiting period will end (or already ended)
resetMs - time since epoch in milliseconds at which the rate limiting period will end (or already ended)
Options
id - the identifier to limit against (typically a user id)
db - redis connection instance
max - max requests within duration [2500]
duration - of limit in milliseconds [3600000]
License
MIT
tjholowaychuk
tj@vision-media.ca
=
(limit.reset
*
1000
)
-
Date.
now
()
|
0
;
var after = limit.reset - (Date.now() / 1000) | 0;