New Feature: Added Rate Limit Management Support in Redis

[JeffersonGibin]

What has been implemented?

Support for Redis has been added, allowing rate limit management directly via Redis. New properties have been added: strategyCache and redis.

Important

• For those using a custom cache where it is necessary to inform the cache field containing the instance of the custom cache, in addition to this field, you will need to add strategyCache: "CUSTOM". If you were using in-memory cache, don't worry, nothing has changed.

Example of Use

• For more details, please consult the README.md.

Redis

import {  RateLimitExpress,  Redis } from "express-rate-limiter-core"; 

const redisClient = Redis.createClient({
    url: 'redis://localhost:6379'
});

redisClient.connect();

const rateLimit = RateLimitExpress({
  // This field is optional and support IN_MEMORY, REDIS and CUSTOM
  strategyCache: 'REDIS',
  
  redis: redisClient,

  policy: {
    type: "REQUEST_PER_SECONDS", // REQUEST_PER_SECONDS, REQUEST_PER_MINUTES

    periodWindow: 10,

    maxRequests: 10,
  },
});

Custom Cache

import {  RateLimitExpress } from "express-rate-limiter-core"; 

class CustomCacheExemple implements CustomCache {}

// Exemple RateLimitExpress with custom cache
const rateLimit = RateLimitExpress({
  // This field is optional and support IN_MEMORY, REDIS and CUSTOM
  strategyCache: 'CUSTOM',

  cache: new CustomCacheExemple(),

  policy: {
    type: "REQUEST_PER_SECONDS", // REQUEST_PER_SECONDS, REQUEST_PER_MINUTES

    periodWindow: 10,

    maxRequests: 10,
  },
});