express-rate-limit 8.4.1 → 8.5.0

package/dist/index.cjs

@@ -861,7 +861,24 @@ var rateLimit = (passedOptions) => {
   const options = getOptionsFromConfig(config);
   config.validations.creationStack(config.store);
   config.validations.unsharedStore(config.store);
-  if (typeof config.store.init === "function") config.store.init(options);
+  if (typeof config.store.init === "function") {
+    try {
+      const storeInit = config.store.init(options);
+      if (storeInit instanceof Promise) {
+        storeInit.catch(
+          (error) => config.logger.error(
+            error,
+            "express-rate-limit: async error during store initialization."
+          )
+        );
+      }
+    } catch (error) {
+      config.logger.error(
+        error,
+        "express-rate-limit: error during store initialization."
+      );
+    }
+  }
   const middleware = handleAsyncErrors(
     async (request, response, next) => {
       const closePromise = config.skipFailedRequests && new Promise((resolve) => response.once("close", resolve));

package/dist/index.d.cts

@@ -285,9 +285,15 @@ export type Store = {
 	 * Method that initializes the store, and has access to the options passed to
 	 * the middleware too.
 	 *
+	 * Called once during initialization.
+	 *
+	 * Errors / promise rejections will be caught and logged.
+	 *
+	 * Note that the result is not awaited - other store methods (such as increment) may be called before init returns and/or after it throws/rejects.
+	 *
 	 * @param options {Options} - The options used to setup the middleware.
 	 */
-	init?: (options: Options) => void;
+	init?: (options: Options) => void | Promise<void>;
 	/**
 	 * Method to fetch a client's hit count and reset time.
 	 *

package/dist/index.d.mts

@@ -285,9 +285,15 @@ export type Store = {
 	 * Method that initializes the store, and has access to the options passed to
 	 * the middleware too.
 	 *
+	 * Called once during initialization.
+	 *
+	 * Errors / promise rejections will be caught and logged.
+	 *
+	 * Note that the result is not awaited - other store methods (such as increment) may be called before init returns and/or after it throws/rejects.
+	 *
 	 * @param options {Options} - The options used to setup the middleware.
 	 */
-	init?: (options: Options) => void;
+	init?: (options: Options) => void | Promise<void>;
 	/**
 	 * Method to fetch a client's hit count and reset time.
 	 *

package/dist/index.d.ts

@@ -285,9 +285,15 @@ export type Store = {
 	 * Method that initializes the store, and has access to the options passed to
 	 * the middleware too.
 	 *
+	 * Called once during initialization.
+	 *
+	 * Errors / promise rejections will be caught and logged.
+	 *
+	 * Note that the result is not awaited - other store methods (such as increment) may be called before init returns and/or after it throws/rejects.
+	 *
 	 * @param options {Options} - The options used to setup the middleware.
 	 */
-	init?: (options: Options) => void;
+	init?: (options: Options) => void | Promise<void>;
 	/**
 	 * Method to fetch a client's hit count and reset time.
 	 *

package/dist/index.mjs

@@ -832,7 +832,24 @@ var rateLimit = (passedOptions) => {
   const options = getOptionsFromConfig(config);
   config.validations.creationStack(config.store);
   config.validations.unsharedStore(config.store);
-  if (typeof config.store.init === "function") config.store.init(options);
+  if (typeof config.store.init === "function") {
+    try {
+      const storeInit = config.store.init(options);
+      if (storeInit instanceof Promise) {
+        storeInit.catch(
+          (error) => config.logger.error(
+            error,
+            "express-rate-limit: async error during store initialization."
+          )
+        );
+      }
+    } catch (error) {
+      config.logger.error(
+        error,
+        "express-rate-limit: error during store initialization."
+      );
+    }
+  }
   const middleware = handleAsyncErrors(
     async (request, response, next) => {
       const closePromise = config.skipFailedRequests && new Promise((resolve) => response.once("close", resolve));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "express-rate-limit",
-	"version": "8.4.1",
+	"version": "8.5.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",
@@ -70,6 +70,7 @@
 		"test:lib": "jest",
 		"test:ext": "cd test/external/ && bash run-all-tests",
 		"test": "run-s lint test:lib",
+		"format-test": "run-s format test:lib",
 		"pre-commit": "lint-staged",
 		"prepare": "run-s compile && husky"
 	},