express-rate-limit 6.2.0 → 6.2.1

package/dist/index.cjs

@@ -101,9 +101,9 @@ var promisifyStore = (passedStore) => {
   return new PromisifiedStore();
 };
 var parseOptions = (passedOptions) => {
-  const options = {
+  const notUndefinedOptions = omitUndefinedOptions(passedOptions);
+  const config = {
     windowMs: 60 * 1e3,
-    store: new MemoryStore(),
     max: 5,
     message: "Too many requests, please try again later.",
     statusCode: 429,
@@ -121,17 +121,17 @@ var parseOptions = (passedOptions) => {
       return request.ip;
     },
     handler: (_request, response, _next, _optionsUsed) => {
-      response.status(options.statusCode).send(options.message);
+      response.status(config.statusCode).send(config.message);
     },
     onLimitReached: (_request, _response, _optionsUsed) => {
     },
-    ...passedOptions
+    ...notUndefinedOptions,
+    store: promisifyStore(notUndefinedOptions.store ?? new MemoryStore())
   };
-  if (typeof options.store.incr !== "function" && typeof options.store.increment !== "function" || typeof options.store.decrement !== "function" || typeof options.store.resetKey !== "function" || typeof options.store.resetAll !== "undefined" && typeof options.store.resetAll !== "function" || typeof options.store.init !== "undefined" && typeof options.store.init !== "function") {
+  if (typeof config.store.increment !== "function" || typeof config.store.decrement !== "function" || typeof config.store.resetKey !== "function" || typeof config.store.resetAll !== "undefined" && typeof config.store.resetAll !== "function" || typeof config.store.init !== "undefined" && typeof config.store.init !== "function") {
     throw new TypeError("An invalid store was passed. Please ensure that the store is a class that implements the `Store` interface.");
   }
-  options.store = promisifyStore(options.store);
-  return options;
+  return config;
 };
 var handleAsyncErrors = (fn) => async (request, response, next) => {
   try {
@@ -220,6 +220,16 @@ var rateLimit = (passedOptions) => {
   middleware.resetKey = options.store.resetKey.bind(options.store);
   return middleware;
 };
+var omitUndefinedOptions = (passedOptions) => {
+  const omittedOptions = {};
+  for (const k of Object.keys(passedOptions)) {
+    const key = k;
+    if (passedOptions[key] !== void 0) {
+      omittedOptions[key] = passedOptions[key];
+    }
+  }
+  return omittedOptions;
+};
 var lib_default = rateLimit;
 module.exports = __toCommonJS(source_exports);
 module.exports = rateLimit; module.exports.default = rateLimit; module.exports.rateLimit = rateLimit; module.exports.MemoryStore = MemoryStore;

package/dist/index.d.ts

@@ -233,7 +233,7 @@ export interface Options {
 	 *
 	 * By default, the built-in `MemoryStore` will be used.
 	 */
-	store: Store;
+	store: Store | LegacyStore;
 	/**
 	 * Whether to send `X-RateLimit-*` headers with the rate limit and the number
 	 * of requests.
@@ -276,9 +276,7 @@ export interface RateLimitInfo {
  *
  * @public
  */
-export declare const rateLimit: (passedOptions?: (Omit<Partial<Options>, "store"> & {
-	store?: LegacyStore | Store | undefined;
-}) | undefined) => RateLimitRequestHandler;
+export declare const rateLimit: (passedOptions?: Partial<Options> | undefined) => RateLimitRequestHandler;
 /**
  * A `Store` that stores the hit count for each client in memory.
  *

package/dist/index.mjs

@@ -70,9 +70,9 @@ var promisifyStore = (passedStore) => {
   return new PromisifiedStore();
 };
 var parseOptions = (passedOptions) => {
-  const options = {
+  const notUndefinedOptions = omitUndefinedOptions(passedOptions);
+  const config = {
     windowMs: 60 * 1e3,
-    store: new MemoryStore(),
     max: 5,
     message: "Too many requests, please try again later.",
     statusCode: 429,
@@ -90,17 +90,17 @@ var parseOptions = (passedOptions) => {
       return request.ip;
     },
     handler: (_request, response, _next, _optionsUsed) => {
-      response.status(options.statusCode).send(options.message);
+      response.status(config.statusCode).send(config.message);
     },
     onLimitReached: (_request, _response, _optionsUsed) => {
     },
-    ...passedOptions
+    ...notUndefinedOptions,
+    store: promisifyStore(notUndefinedOptions.store ?? new MemoryStore())
   };
-  if (typeof options.store.incr !== "function" && typeof options.store.increment !== "function" || typeof options.store.decrement !== "function" || typeof options.store.resetKey !== "function" || typeof options.store.resetAll !== "undefined" && typeof options.store.resetAll !== "function" || typeof options.store.init !== "undefined" && typeof options.store.init !== "function") {
+  if (typeof config.store.increment !== "function" || typeof config.store.decrement !== "function" || typeof config.store.resetKey !== "function" || typeof config.store.resetAll !== "undefined" && typeof config.store.resetAll !== "function" || typeof config.store.init !== "undefined" && typeof config.store.init !== "function") {
     throw new TypeError("An invalid store was passed. Please ensure that the store is a class that implements the `Store` interface.");
   }
-  options.store = promisifyStore(options.store);
-  return options;
+  return config;
 };
 var handleAsyncErrors = (fn) => async (request, response, next) => {
   try {
@@ -189,6 +189,16 @@ var rateLimit = (passedOptions) => {
   middleware.resetKey = options.store.resetKey.bind(options.store);
   return middleware;
 };
+var omitUndefinedOptions = (passedOptions) => {
+  const omittedOptions = {};
+  for (const k of Object.keys(passedOptions)) {
+    const key = k;
+    if (passedOptions[key] !== void 0) {
+      omittedOptions[key] = passedOptions[key];
+    }
+  }
+  return omittedOptions;
+};
 var lib_default = rateLimit;
 export {
   MemoryStore,

package/package.json

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