🔥@hono-rate-limiter/redis🔥

Installation

1# Using npm/yarn/pnpm/bun
2npm add @hono-rate-limiter/redis

Usage

Examples

Using with @vercel/kv

1import { RedisStore } from "@hono-rate-limiter/redis";
2import { kv } from "@vercel/kv";
3import { rateLimiter } from "hono-rate-limiter";
4
5const limiter = rateLimiter({
6  windowMs: 15 * 60 * 1000, // 15 minutes
7  limit: 100, // Limit each IP to 100 requests per `window` (here, per 15 minutes).
8  standardHeaders: "draft-6", // draft-6: `RateLimit-*` headers; draft-7: combined `RateLimit` header
9  keyGenerator: (c) => c.req.header("cf-connecting-ip") ?? "", // Method to generate custom identifiers for clients.
10  store: new RedisStore({ client: kv }), // Redis, MemoryStore, etc. See below.
11});
12
13// Apply the rate limiting middleware to all requests.
14app.use(limiter);

Configuration

client

The function used to send commands to Redis. The function signature is as follows:

1export type RedisClient = {
2  scriptLoad: (script: string) => Promise<string>;
3  evalsha: <TArgs extends unknown[], TData = unknown>(sha1: string, keys: string[], args: TArgs) => Promise<TData>;
4  decr: (key: string) => Promise<number>;
5  del: (key: string) => Promise<number>;
6};

Usage with connectors

@vercel/kv

1import { kv } from "@vercel/kv";
2
3const store = new RedisStore({ client: kv });

@upstash/redis

1import { Redis } from "@upstash/redis"
2/**
3 * for Cloudflare
4 * import { Redis } from "@upstash/redis/cloudflare"
5 */
6
7const redis = new Redis({
8  url: <UPSTASH_REDIS_REST_URL>,
9  token: <UPSTASH_REDIS_REST_TOKEN>,
10})
11
12const store = new RedisStore({ client: redis })

prefix

The text to prepend to the key in Redis.

Defaults to hrl:.

resetExpiryOnChange

Whether to reset the expiry for a particular key whenever its hit count changes.

Defaults to false.

Contributing

We would love to have more contributors involved!

To get started, please read our Contributing Guide.

Credits

The @hono-rate-limiter/redis project is heavily inspired by rate-limit-redis