express-rate-limit 8.1.0 → 8.2.0

package/dist/index.cjs

@@ -521,12 +521,50 @@ var validations = {
       );
     }
   },
+  knownOptions(passedOptions) {
+    if (!passedOptions) return;
+    const optionsMap = {
+      windowMs: true,
+      limit: true,
+      message: true,
+      statusCode: true,
+      legacyHeaders: true,
+      standardHeaders: true,
+      identifier: true,
+      requestPropertyName: true,
+      skipFailedRequests: true,
+      skipSuccessfulRequests: true,
+      keyGenerator: true,
+      ipv6Subnet: true,
+      handler: true,
+      skip: true,
+      requestWasSuccessful: true,
+      store: true,
+      validate: true,
+      headers: true,
+      max: true,
+      passOnStoreError: true
+    };
+    const validOptions = Object.keys(optionsMap).concat(
+      "draft_polli_ratelimit_headers"
+      // not a valid option anymore, but we have a more specific check for this one, so don't warn for it here
+    );
+    for (const key of Object.keys(passedOptions)) {
+      if (!validOptions.includes(key)) {
+        throw new ValidationError(
+          "ERR_ERL_UNKNOWN_OPTION",
+          `Unexpected configuration option: ${key}`
+          // todo: suggest a valid option with a short levenstein distance?
+        );
+      }
+    }
+  },
   /**
    * 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.
+   * includes the list of supported validations.
    */
   validationsConfig() {
     const supportedValidations = Object.keys(this).filter(
@@ -696,6 +734,7 @@ var parseOptions = (passedOptions) => {
   const notUndefinedOptions = omitUndefinedProperties(passedOptions);
   const validations2 = getValidations(notUndefinedOptions?.validate ?? true);
   validations2.validationsConfig();
+  validations2.knownOptions(passedOptions);
   validations2.draftPolliHeaders(
     // @ts-expect-error see the note above.
     notUndefinedOptions.draft_polli_ratelimit_headers

package/dist/index.d.cts

@@ -132,12 +132,13 @@ declare const validations: {
 	 * @returns {void}
 	 */
 	headersResetTime(resetTime?: Date): void;
+	knownOptions(passedOptions?: Partial<Options>): void;
 	/**
 	 * 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.
+	 * includes the list of supported validations.
 	 */
 	validationsConfig(): void;
 	/**

package/dist/index.d.mts

@@ -132,12 +132,13 @@ declare const validations: {
 	 * @returns {void}
 	 */
 	headersResetTime(resetTime?: Date): void;
+	knownOptions(passedOptions?: Partial<Options>): void;
 	/**
 	 * 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.
+	 * includes the list of supported validations.
 	 */
 	validationsConfig(): void;
 	/**

package/dist/index.d.ts

@@ -132,12 +132,13 @@ declare const validations: {
 	 * @returns {void}
 	 */
 	headersResetTime(resetTime?: Date): void;
+	knownOptions(passedOptions?: Partial<Options>): void;
 	/**
 	 * 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.
+	 * includes the list of supported validations.
 	 */
 	validationsConfig(): void;
 	/**

package/dist/index.mjs

@@ -492,12 +492,50 @@ var validations = {
       );
     }
   },
+  knownOptions(passedOptions) {
+    if (!passedOptions) return;
+    const optionsMap = {
+      windowMs: true,
+      limit: true,
+      message: true,
+      statusCode: true,
+      legacyHeaders: true,
+      standardHeaders: true,
+      identifier: true,
+      requestPropertyName: true,
+      skipFailedRequests: true,
+      skipSuccessfulRequests: true,
+      keyGenerator: true,
+      ipv6Subnet: true,
+      handler: true,
+      skip: true,
+      requestWasSuccessful: true,
+      store: true,
+      validate: true,
+      headers: true,
+      max: true,
+      passOnStoreError: true
+    };
+    const validOptions = Object.keys(optionsMap).concat(
+      "draft_polli_ratelimit_headers"
+      // not a valid option anymore, but we have a more specific check for this one, so don't warn for it here
+    );
+    for (const key of Object.keys(passedOptions)) {
+      if (!validOptions.includes(key)) {
+        throw new ValidationError(
+          "ERR_ERL_UNKNOWN_OPTION",
+          `Unexpected configuration option: ${key}`
+          // todo: suggest a valid option with a short levenstein distance?
+        );
+      }
+    }
+  },
   /**
    * 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.
+   * includes the list of supported validations.
    */
   validationsConfig() {
     const supportedValidations = Object.keys(this).filter(
@@ -667,6 +705,7 @@ var parseOptions = (passedOptions) => {
   const notUndefinedOptions = omitUndefinedProperties(passedOptions);
   const validations2 = getValidations(notUndefinedOptions?.validate ?? true);
   validations2.validationsConfig();
+  validations2.knownOptions(passedOptions);
   validations2.draftPolliHeaders(
     // @ts-expect-error see the note above.
     notUndefinedOptions.draft_polli_ratelimit_headers

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "express-rate-limit",
-	"version": "8.1.0",
+	"version": "8.2.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",
@@ -77,29 +77,29 @@
 		"express": ">= 4.11"
 	},
 	"devDependencies": {
-		"@biomejs/biome": "2.2.2",
+		"@biomejs/biome": "2.3.1",
 		"@express-rate-limit/prettier": "1.1.1",
 		"@express-rate-limit/tsconfig": "1.0.2",
-		"@jest/globals": "30.1.2",
-		"@types/express": "5.0.3",
+		"@jest/globals": "30.2.0",
+		"@types/express": "5.0.4",
 		"@types/jest": "30.0.0",
-		"@types/node": "24.3.0",
+		"@types/node": "24.9.1",
 		"@types/supertest": "6.0.3",
 		"del-cli": "6.0.0",
 		"dts-bundle-generator": "8.1.2",
-		"esbuild": "0.25.9",
+		"esbuild": "0.25.11",
 		"express": "5.1.0",
 		"husky": "9.1.7",
-		"jest": "30.1.2",
-		"lint-staged": "16.1.6",
-		"mintlify": "4.2.94",
+		"jest": "30.2.0",
+		"lint-staged": "16.2.6",
+		"mintlify": "4.2.179",
 		"npm-run-all": "4.1.5",
 		"prettier": "3.6.2",
 		"ratelimit-header-parser": "0.1.0",
 		"supertest": "7.1.4",
-		"ts-jest": "29.4.1",
+		"ts-jest": "29.4.5",
 		"ts-node": "10.9.2",
-		"typescript": "5.9.2"
+		"typescript": "5.9.3"
 	},
 	"prettier": "@express-rate-limit/prettier",
 	"lint-staged": {