🔥hono-rate-limiter🔥

Rate limiting middleware for Hono. Use to limit repeated requests to public APIs and/or endpoints such as password reset.

[!NOTE]
The keyGenerator function needs to be defined for hono-rate-limiter to work properly in your environment. Please ensure that you define the keyGenerator function according to the documentation before using the library.

Installation

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

Usage

Rest APIs

1import { rateLimiter } from "hono-rate-limiter";
2
3// Apply the rate limiting middleware to all requests.
4app.use(
5  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) => "<unique_key>", // Method to generate custom identifiers for clients.
10    // store: ... , // Redis, MemoryStore, etc. See below.
11  })
12);

WebSocket APIs

1import { webSocketLimiter } from "hono-rate-limiter";
2import { upgradeWebSocket } from "hono/cloudflare-workers";
3import { RedisStore } from "@hono-rate-limiter/redis";
4import { Redis } from "@upstash/redis/cloudflare";
5
6const limiter = webSocketLimiter({
7  windowMs: 15 * 60 * 1000, // 15 minutes
8  limit: 100, // Limit each IP to 100 requests per `window` (here, per 15 minutes).
9  keyGenerator: (c) => "<unique_key>", // Method to generate custom identifiers for clients.
10  store: new RedisStore({ client }), // Define your DataStore. See below.
11});
12
13// Apply the rate limiting middleware to ws requests.
14app.get(
15  "/",
16  upgradeWebSocket(
17    limiter((c) => {
18      return {
19        onOpen: () => {
20          console.log("Connection opened");
21        },
22        async onMessage(event, ws) {
23          console.log(`Message from client: ${event.data}`);
24          ws.send("Hello from server!");
25        },
26        onClose: () => {
27          console.log("Connection closed");
28        },
29      };
30    })
31  )
32);

Data Stores

hono-rate-limiter supports external data stores to synchronize hit counts across multiple processes and servers.

By default, MemoryStore is used. This one does not synchronize its state across instances. It’s simple to deploy, and often sufficient for basic abuse prevention, but will be inconsistent across reboots or in deployments with multiple process or servers.

Deployments requiring more consistently enforced rate limits should use an external store.

Here is a list of stores:

Name	Description
MemoryStore	(default) Simple in-memory option. Does not share state when the app has multiple processes or servers.
@hono-rate-limiter/redis	A Redis-backed store, used with @vercel/kv and @upstash/redis .
@hono-rate-limiter/cloudflare	A Cloudflare-backed store, used with Durable Object, WorkersKV and Workers Rate Limiting API.
rate-limit-redis	A Redis-backed store, more suitable for large or demanding deployments.
rate-limit-postgresql	A PostgreSQL-backed store.
rate-limit-memcached	A Memcached-backed store.
cluster-memory-store	A memory-store wrapper that shares state across all processes on a single server via the node:cluster module. Does not share state across multiple servers.
precise-memory-rate-limit	A memory store similar to the built-in one, except that it stores a distinct timestamp for each key.
typeorm-rate-limit-store	Supports a variety of databases via TypeORM: MySQL, MariaDB, CockroachDB, SQLite, Microsoft SQL Server, Oracle, SAP Hana, and more.
@rlimit/storage	A distributed rlimit store, ideal for multi-regional deployments.

Take a look at this guide if you wish to create your own store.

Notes

• The keyGenerator function determines what to limit a request on, it should represent a unique characteristic of a user or class of user that you wish to rate limit. Good choices include API keys in Authorization headers, URL paths or routes, specific query parameters used by your application, and/or user IDs.
• It is not recommended to use IP addresses (since these can be shared by many users in many valid cases) or locations (the same), as you may find yourself unintentionally rate limiting a wider group of users than you intended.

Examples

• hono-rate-limiter.vercel.app - Uses Vercel KV and deployed on Vercel
• hono-rate-limiter.rhinobase.workers.dev - Built using Cloudflare Workers

Troubleshooting

If the suggestions here don't work, please try posting questions on GitHub Discussions or in the #help channel of Hono Discord.

Typescript Type Issue

When working with packages that are not officially supported by hono-rate-limiter, you might encounter type-related issues. These can be easily resolved by referring to the discussions in #22, #10. Example -

1rateLimiter({
2  // ...
3  store: new RedisStore({
4    sendCommand: (...args: string[]) => redisClient.sendCommand(args),
5  }) as unknown as Store,
6});

Using hono-rate-limiter with Cloudflare Workers or Pages

If you're trying to use hono-rate-limiter in a Cloudflare environment (such as Workers or Pages), you may encounter the following error:

1Uncaught Error: Disallowed operation called within global scope. Asynchronous I/O (ex: fetch() or connect()), setting a timeout, and generating random values are not allowed within global scope. To fix this error, perform this operation within a handler. https://developers.cloudflare.com/workers/runtime-apis/handlers/

This happens because the default memory store used by hono-rate-limiter cannot run in the Cloudflare environment due to its restrictions on global asynchronous operations.

Solution

To resolve this issue, you need to use a compatible store for Cloudflare. You can use the @hono-rate-limiter/cloudflare package, which is specifically designed to work with Cloudflare's infrastructure.

Contributing

We would love to have more contributors involved!

To get started, please read our Contributing Guide.

Credits

The hono-rate-limiter project is heavily inspired by express-rate-limit