express-rate-limit 6.11.1 → 6.11.2

package/changelog.md

@@ -6,6 +6,13 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [6.11.2](https://github.com/express-rate-limit/express-rate-limit/releases/tag/v6.11.2)
+
+Fixed:
+
+- Restored `IncrementResponse ` TypeScript type (See
+  [#397](https://github.com/express-rate-limit/express-rate-limit/pull/397))
+
 ## [6.11.1](https://github.com/express-rate-limit/express-rate-limit/releases/tag/v6.11.1)
 
 ### Fixed

package/dist/index.d.cts

@@ -50,6 +50,7 @@ export type ClientRateLimitInfo = {
 	totalHits: number;
 	resetTime: Date | undefined;
 };
+export type IncrementResponse = ClientRateLimitInfo;
 /**
  * A modified Express request handler with the rate limit functions.
  */
@@ -123,9 +124,9 @@ export type Store = {
 	 *
 	 * @param key {string} - The identifier for a client.
 	 *
-	 * @returns {ClientRateLimitInfo | undefined} - The number of hits and reset time for that client.
+	 * @returns {IncrementResponse | undefined} - The number of hits and reset time for that client.
 	 */
-	increment: (key: string) => Promise<ClientRateLimitInfo> | ClientRateLimitInfo;
+	increment: (key: string) => Promise<IncrementResponse> | IncrementResponse;
 	/**
 	 * Method to decrement a client's hit counter.
 	 *

package/dist/index.d.mts

@@ -50,6 +50,7 @@ export type ClientRateLimitInfo = {
 	totalHits: number;
 	resetTime: Date | undefined;
 };
+export type IncrementResponse = ClientRateLimitInfo;
 /**
  * A modified Express request handler with the rate limit functions.
  */
@@ -123,9 +124,9 @@ export type Store = {
 	 *
 	 * @param key {string} - The identifier for a client.
 	 *
-	 * @returns {ClientRateLimitInfo | undefined} - The number of hits and reset time for that client.
+	 * @returns {IncrementResponse | undefined} - The number of hits and reset time for that client.
 	 */
-	increment: (key: string) => Promise<ClientRateLimitInfo> | ClientRateLimitInfo;
+	increment: (key: string) => Promise<IncrementResponse> | IncrementResponse;
 	/**
 	 * Method to decrement a client's hit counter.
 	 *

package/dist/index.d.ts

@@ -50,6 +50,7 @@ export type ClientRateLimitInfo = {
 	totalHits: number;
 	resetTime: Date | undefined;
 };
+export type IncrementResponse = ClientRateLimitInfo;
 /**
  * A modified Express request handler with the rate limit functions.
  */
@@ -123,9 +124,9 @@ export type Store = {
 	 *
 	 * @param key {string} - The identifier for a client.
 	 *
-	 * @returns {ClientRateLimitInfo | undefined} - The number of hits and reset time for that client.
+	 * @returns {IncrementResponse | undefined} - The number of hits and reset time for that client.
 	 */
-	increment: (key: string) => Promise<ClientRateLimitInfo> | ClientRateLimitInfo;
+	increment: (key: string) => Promise<IncrementResponse> | IncrementResponse;
 	/**
 	 * Method to decrement a client's hit counter.
 	 *

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "express-rate-limit",
-	"version": "6.11.1",
+	"version": "6.11.2",
 	"description": "Basic IP rate-limiting middleware for Express. Use to limit repeated requests to public APIs and/or endpoints such as password reset.",
 	"author": {
 		"name": "Nathan Friedly",