express-rate-limit 7.0.2 → 7.1.0

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).
 
+## [7.1.0](https://github.com/express-rate-limit/express-rate-limit/releases/tag/v7.1.0)
+
+### Changed
+
+- The `getKey` method is now always defined. If the store does not have the
+  required `get` method, `getKey` will throw an error explaining this.
+
 ## [7.0.2](https://github.com/express-rate-limit/express-rate-limit/releases/tag/v7.0.2)
 
 ### Added

package/dist/index.cjs

@@ -506,10 +506,6 @@ var promisifyStore = (passedStore) => {
   }
   const legacyStore = passedStore;
   class PromisifiedStore {
-    /* istanbul ignore next */
-    async get(key) {
-      return void 0;
-    }
     async increment(key) {
       return new Promise((resolve, reject) => {
         legacyStore.incr(
@@ -699,10 +695,11 @@ var rateLimit = (passedOptions) => {
       next();
     }
   );
+  const getThrowFn = () => {
+    throw new Error("The current store does not support the get/getKey method");
+  };
   middleware.resetKey = config.store.resetKey.bind(config.store);
-  middleware.getKey = config.store.get?.bind(
-    config.store
-  );
+  middleware.getKey = typeof config.store.get === "function" ? config.store.get.bind(config.store) : getThrowFn;
   return middleware;
 };
 var lib_default = rateLimit;

package/dist/index.d.cts

@@ -165,7 +165,7 @@ export type RateLimitRequestHandler = RequestHandler & {
 	 *
 	 * @returns {ClientRateLimitInfo} - The number of hits and reset time for that client.
 	 */
-	getKey?: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
+	getKey: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
 };
 /**
  * An interface that all hit counter stores must implement.

package/dist/index.d.mts

@@ -165,7 +165,7 @@ export type RateLimitRequestHandler = RequestHandler & {
 	 *
 	 * @returns {ClientRateLimitInfo} - The number of hits and reset time for that client.
 	 */
-	getKey?: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
+	getKey: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
 };
 /**
  * An interface that all hit counter stores must implement.

package/dist/index.d.ts

@@ -165,7 +165,7 @@ export type RateLimitRequestHandler = RequestHandler & {
 	 *
 	 * @returns {ClientRateLimitInfo} - The number of hits and reset time for that client.
 	 */
-	getKey?: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
+	getKey: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
 };
 /**
  * An interface that all hit counter stores must implement.

package/dist/index.mjs

@@ -478,10 +478,6 @@ var promisifyStore = (passedStore) => {
   }
   const legacyStore = passedStore;
   class PromisifiedStore {
-    /* istanbul ignore next */
-    async get(key) {
-      return void 0;
-    }
     async increment(key) {
       return new Promise((resolve, reject) => {
         legacyStore.incr(
@@ -671,10 +667,11 @@ var rateLimit = (passedOptions) => {
       next();
     }
   );
+  const getThrowFn = () => {
+    throw new Error("The current store does not support the get/getKey method");
+  };
   middleware.resetKey = config.store.resetKey.bind(config.store);
-  middleware.getKey = config.store.get?.bind(
-    config.store
-  );
+  middleware.getKey = typeof config.store.get === "function" ? config.store.get.bind(config.store) : getThrowFn;
   return middleware;
 };
 var lib_default = rateLimit;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "express-rate-limit",
-	"version": "7.0.2",
+	"version": "7.1.0",
 	"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",

package/readme.md

@@ -554,6 +554,10 @@ to complete a captcha to reset their rate limit, then call this function.
 
 Retrieves the hit count and reset time from the store for a given key.
 
+Note: `getKey` depends on store support. It works with the MemoryStore, but may
+not work with other stores. Calling it will throw an error if the store does not
+have a `get` method.
+
 ## Issues and Contributing
 
 If you encounter a bug or want to see something added/changed, please go ahead