Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
@tinyhttp/rate-limit
Advanced tools
Readme
Basic rate-limiting middleware for tinyhttp. Used to limit repeated requests to public APIs and/or endpoints such as password reset.
pnpm i @tinyhttp/rate-limit
import { App } from '@tinyhttp/app'
import { rateLimit } from '@tinyhttp/rate-limit'
new App().get('limited-route', rateLimit({ max: 10, windowMs: 60 * 1000 /* 1 minute */ }), (_, res) =>
res.send('Limited route')
)
Name | Type | Default | Description |
---|---|---|---|
windowMs | number | 5000 | Timeframe for which requests are checked/remembered. |
max | number | ((req: Request, res: Response) => Promise) | 5 | Max number of connections during windowMs before sending a 429 response. |
message | string | Too many requests, please try again later. | Error message sent to user when max is exceeded. |
statusCode | number | 429 | HTTP status code returned when max is exceeded. |
skipFailedRequests | boolean | false | When set to true, failed requests won't be counted. |
skipSuccessfulRequests | boolean | false | When set to true successful requests (response status < 400) won't be counted. |
keyGenerator | (req: Request, res: Response) => string | (req) => req.ip | Function used to generate keys. |
shouldSkip | (req: Request, res: Response) => boolean | () => false | Determine per request if it should be skipped by the middleware |
onLimitReached | onLimitReached: (req: Request, res: Response) => void | () => {} | Function that is called the first time a user hits the rate limit within a given window. |
store | Store | MemoryStore | By default a MemoryStore is used. Rate Limit Redis, Rate Limit Memcached and Rate Limit Mongo can be used too. |
FAQs
Basic IP rate-limiting middleware for tinyhttp. Use to limit repeated requests to public APIs and/or endpoints such as password reset.
The npm package @tinyhttp/rate-limit receives a total of 51 weekly downloads. As such, @tinyhttp/rate-limit popularity was classified as not popular.
We found that @tinyhttp/rate-limit demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.