Rate limit made simple, easy, async. Based on ratelimiter.
$ npm install async-ratelimiter --saveA simple middleware implementation for whatever HTTP server:
'use strict'
const RateLimiter = require('async-ratelimiter')
const { getClientIp } = require('request-ip')
const Redis = require('ioredis')
const rateLimiter = new RateLimiter({
db: new Redis()
})
const apiQuota = async (req, res, next) => {
const clientIp = getClientIp(req)
const limit = await rateLimiter.get({ id: clientIp })
if (!res.writableEnded) {
res.setHeader('X-Rate-Limit-Limit', limit.total)
res.setHeader('X-Rate-Limit-Remaining', Math.max(0, limit.remaining - 1))
res.setHeader('X-Rate-Limit-Reset', limit.reset)
}
return !limit.remaining
? sendFail({
req,
res,
code: HTTPStatus.TOO_MANY_REQUESTS,
message: MESSAGES.RATE_LIMIT_EXCEDEED()
})
: next(req, res)
}It creates an rate limiter instance.
Required
Type: object
The redis connection instance.
Type: number
Default: 2500
The maximum number of requests within duration.
Type: number
Default: 3600000
How long keep records of requests in milliseconds.
Type: string
Default: 'limit'
The prefix used for compound the key.
Type: string
The identifier to limit against (typically a user id).
You can pass this value using when you use .get method as well.
Given an id, returns a Promise with the status of the limit with the following structure:
total:maxvalue.remaining: number of calls left in currentdurationwithout decreasing currentget.reset: time since epoch in seconds that the rate limiting period will end (or already ended).
Type: string
Default: this.id
The identifier to limit against (typically a user id).
Type: number
Default: this.max
The maximum number of requests within duration. If provided, it overrides the default max value. This is useful for custom limits that differ between IDs.
Type: number
Default: this.max
How long keep records of requests in milliseconds. If provided, it overrides the default duration value.
It provides the command definition so you can load it into any ioredis instance:
const Redis = require('ioredis')
const redis = new Redis(uri, {
scripts: { ...require('async-ratelimiter').defineCommand }
})- express-slow-down – Slow down repeated requests; use as an alternative (or addition) to express-rate-limit.
async-ratelimiter © microlink.io, released under the MIT License.
Authored and maintained by Kiko Beats with help from contributors.
microlink.io · GitHub microlink.io · X @microlinkhq