Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
express-rate-limit
Advanced tools
express-rate-limit - npm Package Compare versions
Comparing version 7.3.0 to 7.3.1
@@ -63,4 +63,4 @@ // Generated by dts-bundle-generator v8.0.1 | ||
| /** | ||
| * Warns the user that the behaviour for `max: 0` / `limit: 0` is changing in the next | ||
| * major release. | ||
| * Warns the user that the behaviour for `max: 0` / `limit: 0` is | ||
| * changing in the next major release. | ||
| * | ||
@@ -82,4 +82,4 @@ * @param limit {number} - The maximum number of hits per client. | ||
| /** | ||
| * Warns the user that the `onLimitReached` option is deprecated and will be removed in the next | ||
| * major release. | ||
| * Warns the user that the `onLimitReached` option is deprecated and | ||
| * will be removed in the next major release. | ||
| * | ||
@@ -101,11 +101,15 @@ * @param onLimitReached {any | undefined} - The maximum number of hits per client. | ||
| /** | ||
| * Checks the options.validate setting to ensure that only recognized validations are enabled or disabled. | ||
| * Checks the options.validate setting to ensure that only recognized | ||
| * validations are enabled or disabled. | ||
| * | ||
| * If any unrecognized values are found, an error is logged that includes the list of supported vaidations. | ||
| * If any unrecognized values are found, an error is logged that | ||
| * includes the list of supported vaidations. | ||
| */ | ||
| validationsConfig(): void; | ||
| /** | ||
| * Checks to see if the instance was created inside of a request handler, which would prevent it from working correctly. | ||
| * Checks to see if the instance was created inside of a request handler, | ||
| * which would prevent it from working correctly, with the default memory | ||
| * store (or any other store with localKeys.) | ||
| */ | ||
| creationStack(): void; | ||
| creationStack(store: Store): void; | ||
| }; | ||
@@ -112,0 +116,0 @@ export type Validations = typeof validations; |
| { | ||
| "name": "express-rate-limit", | ||
| "version": "7.3.0", | ||
| "version": "7.3.1", | ||
| "description": "Basic IP rate-limiting middleware for Express. Use to limit repeated requests to public APIs and/or endpoints such as password reset.", | ||
@@ -5,0 +5,0 @@ "author": { |
@@ -48,19 +48,19 @@ <h1 align="center"> <code>express-rate-limit</code> </h1> | ||
| | Option | Type | Remarks | | ||
| | ------------------------------------------------------------------------------------------------------------------ | -------------------------------- | ----------------------------------------------------------------------------------------------- | | ||
| | [`windowMs`](https://express-rate-limit.mintlify.app/reference/configuration#windowms) | `number` | How long to remember requests for, in milliseconds. | | ||
| | [`limit`](https://express-rate-limit.mintlify.app/reference/configuration#limit) | `number` \| `function` | How many requests to allow. | | ||
| | [`message`](https://express-rate-limit.mintlify.app/reference/configuration#message) | `string` \| `json` \| `function` | Response to return after limit is reached. | | ||
| | [`statusCode`](https://express-rate-limit.mintlify.app/reference/configuration#statuscode) | `number` | HTTP status code after limit is reached (default is 429). | | ||
| | [`legacyHeaders`](https://express-rate-limit.mintlify.app/reference/configuration#legacyheaders) | `boolean` | Enable the `X-Rate-Limit` header. | | ||
| | [`standardHeaders`](https://express-rate-limit.mintlify.app/reference/configuration#standardheaders) | `'draft-6'` \| `'draft-7'` | Enable the `Ratelimit` header. | | ||
| | [`requestPropertyName`](https://express-rate-limit.mintlify.app/reference/configuration#requestpropertyname) | `string` | Add rate limit info to the `req` object. | | ||
| | [`skipFailedRequests`](https://express-rate-limit.mintlify.app/reference/configuration#skipfailedrequests) | `boolean` | Uncount 4xx/5xx responses. | | ||
| | [`skipSuccessfulRequests`](https://express-rate-limit.mintlify.app/reference/configuration#skipsuccessfulrequests) | `boolean` | Uncount 1xx/2xx/3xx responses. | | ||
| | [`keyGenerator`](https://express-rate-limit.mintlify.app/reference/configuration#keygenerator) | `function` | Identify users (defaults to IP address). | | ||
| | [`handler`](https://express-rate-limit.mintlify.app/reference/configuration#handler) | `function` | Function to run after limit is reached (overrides `message` and `statusCode` settings, if set). | | ||
| | [`skip`](https://express-rate-limit.mintlify.app/reference/configuration#skip) | `function` | Return `true` to bypass the limiter for the given request. | | ||
| | [`requestWasSuccessful`](https://express-rate-limit.mintlify.app/reference/configuration#requestwassuccessful) | `function` | Used by `skipFailedRequests` and `skipSuccessfulRequests`. | | ||
| | [`validate`](https://express-rate-limit.mintlify.app/reference/configuration#validate) | `boolean` \| `object` | Enable or disable built-in validation checks. | | ||
| | [`store`](https://express-rate-limit.mintlify.app/reference/configuration#store) | `Store` | Use a custom store to share hit counts across multiple nodes. | | ||
| | Option | Type | Remarks | | ||
| | -------------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------- | | ||
| | [`windowMs`] | `number` | How long to remember requests for, in milliseconds. | | ||
| | [`limit`] | `number` \| `function` | How many requests to allow. | | ||
| | [`message`] | `string` \| `json` \| `function` | Response to return after limit is reached. | | ||
| | [`statusCode`] | `number` | HTTP status code after limit is reached (default is 429). | | ||
| | [`handler`] | `function` | Function to run after limit is reached (overrides `message` and `statusCode` settings, if set). | | ||
| | [`legacyHeaders`] | `boolean` | Enable the `X-Rate-Limit` header. | | ||
| | [`standardHeaders`] | `'draft-6'` \| `'draft-7'` | Enable the `Ratelimit` header. | | ||
| | [`store`] | `Store` | Use a custom store to share hit counts across multiple nodes. | | ||
| | [`keyGenerator`] | `function` | Identify users (defaults to IP address). | | ||
| | [`requestPropertyName`] | `string` | Add rate limit info to the `req` object. | | ||
| | [`skip`] | `function` | Return `true` to bypass the limiter for the given request. | | ||
| | [`skipSuccessfulRequests`] | `boolean` | Uncount 1xx/2xx/3xx responses. | | ||
| | [`skipFailedRequests`] | `boolean` | Uncount 4xx/5xx responses. | | ||
| | [`requestWasSuccessful`] | `function` | Used by `skipSuccessfulRequests` and `skipFailedRequests`. | | ||
| | [`validate`] | `boolean` \| `object` | Enable or disable built-in validation checks. | | ||
@@ -115,1 +115,29 @@ ## Thank You | ||
| [Vedant K](https://github.com/gamemaker1) | ||
| [`windowMs`]: | ||
| https://express-rate-limit.mintlify.app/reference/configuration#windowms | ||
| [`limit`]: https://express-rate-limit.mintlify.app/reference/configuration#limit | ||
| [`message`]: | ||
| https://express-rate-limit.mintlify.app/reference/configuration#message | ||
| [`statusCode`]: | ||
| https://express-rate-limit.mintlify.app/reference/configuration#statuscode | ||
| [`handler`]: | ||
| https://express-rate-limit.mintlify.app/reference/configuration#handler | ||
| [`legacyHeaders`]: | ||
| https://express-rate-limit.mintlify.app/reference/configuration#legacyheaders | ||
| [`standardHeaders`]: | ||
| https://express-rate-limit.mintlify.app/reference/configuration#standardheaders | ||
| [`store`]: https://express-rate-limit.mintlify.app/reference/configuration#store | ||
| [`keyGenerator`]: | ||
| https://express-rate-limit.mintlify.app/reference/configuration#keygenerator | ||
| [`requestPropertyName`]: | ||
| https://express-rate-limit.mintlify.app/reference/configuration#requestpropertyname | ||
| [`skip`]: https://express-rate-limit.mintlify.app/reference/configuration#skip | ||
| [`skipSuccessfulRequests`]: | ||
| https://express-rate-limit.mintlify.app/reference/configuration#skipsuccessfulrequests | ||
| [`skipFailedRequests`]: | ||
| https://express-rate-limit.mintlify.app/reference/configuration#skipfailedrequests | ||
| [`requestWasSuccessful`]: | ||
| https://express-rate-limit.mintlify.app/reference/configuration#requestwassuccessful | ||
| [`validate`]: | ||
| https://express-rate-limit.mintlify.app/reference/configuration#validate |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by0.82%
115388
- Lines of code
- increased by1.19%
2035
- Number of lines in readme file
- increased by24.56%
142
No dependency changes