From 0d3c6192459d17354f7b45b33c0c4f21ced5c8d0 Mon Sep 17 00:00:00 2001 From: Alex Gleason Date: Tue, 18 Jun 2024 15:24:44 -0500 Subject: [PATCH] rateLimitMiddleware: improve tsdoc comment --- src/middleware/rateLimitMiddleware.ts | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/src/middleware/rateLimitMiddleware.ts b/src/middleware/rateLimitMiddleware.ts index 9aeef34b..689f7cee 100644 --- a/src/middleware/rateLimitMiddleware.ts +++ b/src/middleware/rateLimitMiddleware.ts @@ -1,8 +1,11 @@ import { MiddlewareHandler } from '@hono/hono'; import { rateLimiter } from 'hono-rate-limiter'; -/** Rate limit middleware for Hono. */ +/** + * Rate limit middleware for Hono, based on [`hono-rate-limiter`](https://github.com/rhinobase/hono-rate-limiter). + */ export function rateLimitMiddleware(limit: number, windowMs: number): MiddlewareHandler { + // @ts-ignore Mismatched hono versions. return rateLimiter({ limit, windowMs,