rateLimitMiddleware: improve tsdoc comment

This commit is contained in:
Alex Gleason 2024-06-18 15:24:44 -05:00
parent 330b38ff68
commit 0d3c619245
No known key found for this signature in database
GPG key ID: 7211D1F99744FBB7

View file

@ -1,8 +1,11 @@
import { MiddlewareHandler } from '@hono/hono'; import { MiddlewareHandler } from '@hono/hono';
import { rateLimiter } from 'hono-rate-limiter'; 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 { export function rateLimitMiddleware(limit: number, windowMs: number): MiddlewareHandler {
// @ts-ignore Mismatched hono versions.
return rateLimiter({ return rateLimiter({
limit, limit,
windowMs, windowMs,