express-rate-limit 6.0.0 → 6.0.4

package/dist/cjs/types.d.ts

@@ -1,239 +0,0 @@
-import Express from 'express';
-/**
- * Callback that fires when a client's hit counter is incremented.
- *
- * @param error {Error | undefined} - The error that occurred, if any
- * @param totalHits {number} - The number of hits for that client so far
- * @param resetTime {Date | undefined} - The time when the counter resets
- */
-export declare type IncrementCallback = (error: Error | undefined, totalHits: number, resetTime: Date | undefined) => void;
-/**
- * Method (in the form of middleware) to generate/retrieve a value based on the
- * incoming request
- *
- * @param request {Express.Request} - The Express request object
- * @param response {Express.Response} - The Express response object
- *
- * @returns {T} - The value needed
- */
-export declare type ValueDeterminingMiddleware<T> = (request: Express.Request, response: Express.Response) => T | Promise<T>;
-/**
- * Express request handler that sends back a response when a client is
- * rate-limited.
- *
- * @param request {Express.Request} - The Express request object
- * @param response {Express.Response} - The Express response object
- * @param next {Express.NextFunction} - The Express `next` function, can be called to skip responding
- * @param optionsUsed {Options} - The options used to set up the middleware
- */
-export declare type RateLimitExceededEventHandler = (request: Express.Request, response: Express.Response, next: Express.NextFunction, optionsUsed: Options) => void;
-/**
- * Event callback that is triggered on a client's first request that exceeds the limit
- * but not for subsequent requests. May be used for logging, etc. Should *not*
- * send a response.
- *
- * @param request {Express.Request} - The Express request object
- * @param response {Express.Response} - The Express response object
- * @param optionsUsed {Options} - The options used to set up the middleware
- */
-export declare type RateLimitReachedEventHandler = (request: Express.Request, response: Express.Response, optionsUsed: Options) => void;
-/**
- * Data returned from the `Store` when a client's hit counter is incremented.
- *
- * @property totalHits {number} - The number of hits for that client so far
- * @property resetTime {Date | undefined} - The time when the counter resets
- */
-export declare type IncrementResponse = {
-    totalHits: number;
-    resetTime: Date | undefined;
-};
-/**
- * A modified Express request handler with the rate limit functions.
- */
-export declare type RateLimitRequestHandler = Express.RequestHandler & {
-    /**
-     * Method to reset a client's hit counter.
-     *
-     * @param key {string} - The identifier for a client
-     */
-    resetKey: (key: string) => void;
-};
-/**
- * An interface that all hit counter stores must implement.
- *
- * @deprecated 6.x - Implement the `Store` interface instead.
- */
-export interface LegacyStore {
-    /**
-     * Method to increment a client's hit counter.
-     *
-     * @param key {string} - The identifier for a client
-     * @param callback {IncrementCallback} - The callback to call once the counter is incremented
-     */
-    incr: (key: string, callback: IncrementCallback) => void;
-    /**
-     * Method to decrement a client's hit counter.
-     *
-     * @param key {string} - The identifier for a client
-     */
-    decrement: (key: string) => void;
-    /**
-     * Method to reset a client's hit counter.
-     *
-     * @param key {string} - The identifier for a client
-     */
-    resetKey: (key: string) => void;
-    /**
-     * Method to reset everyone's hit counter.
-     */
-    resetAll?: () => void;
-}
-/**
- * An interface that all hit counter stores must implement.
- */
-export interface Store {
-    /**
-     * Method that initializes the store, and has access to the options passed to
-     * the middleware too.
-     *
-     * @param options {Options} - The options used to setup the middleware
-     */
-    init?: (options: Options) => void;
-    /**
-     * Method to increment a client's hit counter.
-     *
-     * @param key {string} - The identifier for a client
-     *
-     * @returns {IncrementResponse} - The number of hits and reset time for that client
-     */
-    increment: (key: string) => Promise<IncrementResponse> | IncrementResponse;
-    /**
-     * Method to decrement a client's hit counter.
-     *
-     * @param key {string} - The identifier for a client
-     */
-    decrement: (key: string) => Promise<void> | void;
-    /**
-     * Method to reset a client's hit counter.
-     *
-     * @param key {string} - The identifier for a client
-     */
-    resetKey: (key: string) => Promise<void> | void;
-    /**
-     * Method to reset everyone's hit counter.
-     */
-    resetAll?: () => Promise<void> | void;
-}
-/**
- * The configuration options for the rate limiter.
- */
-export interface Options {
-    /**
-     * How long we should remember the requests.
-     */
-    readonly windowMs: number;
-    /**
-     * The maximum number of connection to allow during the `window` before
-     * rate limiting the client.
-     *
-     * Can be the limit itself as a number or express middleware that parses
-     * the request and then figures out the limit.
-     */
-    readonly max: number | ValueDeterminingMiddleware<number>;
-    /**
-     * The response body to send back when a client is rate limited.
-     */
-    readonly message: any;
-    /**
-     * The HTTP status code to send back when a client is rate limited.
-     *
-     * Defaults to `HTTP 429 Too Many Requests` (RFC 6585).
-     */
-    readonly statusCode: number;
-    /**
-     * Whether to send `X-RateLimit-*` headers with the rate limit and the number
-     * of requests.
-     */
-    readonly legacyHeaders: boolean;
-    /**
-     * Whether to enable support for the rate limit standardization headers (`RateLimit-*`).
-     */
-    readonly standardHeaders: boolean;
-    /**
-     * The name of the property on the request object to store the rate limit info.
-     *
-     * Defaults to `rateLimit`.
-     */
-    readonly requestPropertyName: string;
-    /**
-     * If `true`, the library will (by default) skip all requests that have a 4XX
-     * or 5XX status.
-     */
-    readonly skipFailedRequests: boolean;
-    /**
-     * If `true`, the library will (by default) skip all requests that have a
-     * status code less than 400.
-     */
-    readonly skipSuccessfulRequests: boolean;
-    /**
-     * Method to determine whether or not the request counts as 'succesful'. Used
-     * when either `skipSuccessfulRequests` or `skipFailedRequests` is set to true.
-     */
-    readonly requestWasSuccessful: ValueDeterminingMiddleware<boolean>;
-    /**
-     * Method to generate custom identifiers for clients.
-     *
-     * By default, the client's IP address is used.
-     */
-    readonly keyGenerator: ValueDeterminingMiddleware<string>;
-    /**
-     * Method (in the form of middleware) to determine whether or not this request
-     * counts towards a client's quota.
-     */
-    readonly skip: ValueDeterminingMiddleware<boolean>;
-    /**
-     * Express request handler that sends back a response when a client is
-     * rate-limited.
-     */
-    readonly handler: RateLimitExceededEventHandler;
-    /**
-     * Express request handler that sends back a response when a client has
-     * reached their rate limit, and will be rate limited on their next request.
-     */
-    readonly onLimitReached: RateLimitReachedEventHandler;
-    /**
-     * The {@link Store} to use to store the hit count for each client.
-     */
-    store: Store;
-    /**
-     * Whether to send `X-RateLimit-*` headers with the rate limit and the number
-     * of requests.
-     *
-     * @deprecated 6.x - This option was renamed to `legacyHeaders`.
-     */
-    headers?: boolean;
-    /**
-     * Whether to send `RateLimit-*` headers with the rate limit and the number
-     * of requests.
-     *
-     * @deprecated 6.x - This option was renamed to `standardHeaders`.
-     */
-    draft_polli_ratelimit_headers?: boolean;
-}
-/**
- * The extended request object that includes information about the client's
- * rate limit.
- */
-export declare type AugmentedRequest = Express.Request & {
-    [key: string]: RateLimitInfo;
-};
-/**
- * The rate limit related information for each client included in the
- * Express request object.
- */
-export interface RateLimitInfo {
-    readonly limit: number;
-    readonly current: number;
-    readonly remaining: number;
-    readonly resetTime: Date | undefined;
-}

package/dist/cjs/types.js

@@ -1,5 +0,0 @@
-"use strict";
-// /source/types.ts
-// All the types used by this package
-exports.__esModule = true;
-//# sourceMappingURL=types.js.map

package/dist/cjs/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../source/types.ts"],"names":[],"mappings":";AAAA,mBAAmB;AACnB,qCAAqC","sourcesContent":["// /source/types.ts\n// All the types used by this package\n\nimport Express from 'express'\n\n/**\n * Callback that fires when a client's hit counter is incremented.\n *\n * @param error {Error | undefined} - The error that occurred, if any\n * @param totalHits {number} - The number of hits for that client so far\n * @param resetTime {Date | undefined} - The time when the counter resets\n */\nexport type IncrementCallback = (\n\terror: Error | undefined,\n\ttotalHits: number,\n\tresetTime: Date | undefined,\n) => void\n\n/**\n * Method (in the form of middleware) to generate/retrieve a value based on the\n * incoming request\n *\n * @param request {Express.Request} - The Express request object\n * @param response {Express.Response} - The Express response object\n *\n * @returns {T} - The value needed\n */\nexport type ValueDeterminingMiddleware<T> = (\n\trequest: Express.Request,\n\tresponse: Express.Response,\n) => T | Promise<T>\n\n/**\n * Express request handler that sends back a response when a client is\n * rate-limited.\n *\n * @param request {Express.Request} - The Express request object\n * @param response {Express.Response} - The Express response object\n * @param next {Express.NextFunction} - The Express `next` function, can be called to skip responding\n * @param optionsUsed {Options} - The options used to set up the middleware\n */\nexport type RateLimitExceededEventHandler = (\n\trequest: Express.Request,\n\tresponse: Express.Response,\n\tnext: Express.NextFunction,\n\toptionsUsed: Options,\n) => void\n\n/**\n * Event callback that is triggered on a client's first request that exceeds the limit\n * but not for subsequent requests. May be used for logging, etc. Should *not*\n * send a response.\n *\n * @param request {Express.Request} - The Express request object\n * @param response {Express.Response} - The Express response object\n * @param optionsUsed {Options} - The options used to set up the middleware\n */\nexport type RateLimitReachedEventHandler = (\n\trequest: Express.Request,\n\tresponse: Express.Response,\n\toptionsUsed: Options,\n) => void\n\n/**\n * Data returned from the `Store` when a client's hit counter is incremented.\n *\n * @property totalHits {number} - The number of hits for that client so far\n * @property resetTime {Date | undefined} - The time when the counter resets\n */\nexport type IncrementResponse = {\n\ttotalHits: number\n\tresetTime: Date | undefined\n}\n\n/**\n * A modified Express request handler with the rate limit functions.\n */\nexport type RateLimitRequestHandler = Express.RequestHandler & {\n\t/**\n\t * Method to reset a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t */\n\tresetKey: (key: string) => void\n}\n\n/**\n * An interface that all hit counter stores must implement.\n *\n * @deprecated 6.x - Implement the `Store` interface instead.\n */\nexport interface LegacyStore {\n\t/**\n\t * Method to increment a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t * @param callback {IncrementCallback} - The callback to call once the counter is incremented\n\t */\n\tincr: (key: string, callback: IncrementCallback) => void\n\n\t/**\n\t * Method to decrement a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t */\n\tdecrement: (key: string) => void\n\n\t/**\n\t * Method to reset a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t */\n\tresetKey: (key: string) => void\n\n\t/**\n\t * Method to reset everyone's hit counter.\n\t */\n\tresetAll?: () => void\n}\n\n/**\n * An interface that all hit counter stores must implement.\n */\nexport interface Store {\n\t/**\n\t * Method that initializes the store, and has access to the options passed to\n\t * the middleware too.\n\t *\n\t * @param options {Options} - The options used to setup the middleware\n\t */\n\tinit?: (options: Options) => void\n\n\t/**\n\t * Method to increment a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t *\n\t * @returns {IncrementResponse} - The number of hits and reset time for that client\n\t */\n\tincrement: (key: string) => Promise<IncrementResponse> | IncrementResponse\n\n\t/**\n\t * Method to decrement a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t */\n\tdecrement: (key: string) => Promise<void> | void\n\n\t/**\n\t * Method to reset a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t */\n\tresetKey: (key: string) => Promise<void> | void\n\n\t/**\n\t * Method to reset everyone's hit counter.\n\t */\n\tresetAll?: () => Promise<void> | void\n}\n\n/**\n * The configuration options for the rate limiter.\n */\nexport interface Options {\n\t/**\n\t * How long we should remember the requests.\n\t */\n\treadonly windowMs: number\n\n\t/**\n\t * The maximum number of connection to allow during the `window` before\n\t * rate limiting the client.\n\t *\n\t * Can be the limit itself as a number or express middleware that parses\n\t * the request and then figures out the limit.\n\t */\n\treadonly max: number | ValueDeterminingMiddleware<number>\n\n\t/**\n\t * The response body to send back when a client is rate limited.\n\t */\n\treadonly message: any\n\n\t/**\n\t * The HTTP status code to send back when a client is rate limited.\n\t *\n\t * Defaults to `HTTP 429 Too Many Requests` (RFC 6585).\n\t */\n\treadonly statusCode: number\n\n\t/**\n\t * Whether to send `X-RateLimit-*` headers with the rate limit and the number\n\t * of requests.\n\t */\n\treadonly legacyHeaders: boolean\n\n\t/**\n\t * Whether to enable support for the rate limit standardization headers (`RateLimit-*`).\n\t */\n\treadonly standardHeaders: boolean\n\n\t/**\n\t * The name of the property on the request object to store the rate limit info.\n\t *\n\t * Defaults to `rateLimit`.\n\t */\n\treadonly requestPropertyName: string\n\n\t/**\n\t * If `true`, the library will (by default) skip all requests that have a 4XX\n\t * or 5XX status.\n\t */\n\treadonly skipFailedRequests: boolean\n\n\t/**\n\t * If `true`, the library will (by default) skip all requests that have a\n\t * status code less than 400.\n\t */\n\treadonly skipSuccessfulRequests: boolean\n\n\t/**\n\t * Method to determine whether or not the request counts as 'succesful'. Used\n\t * when either `skipSuccessfulRequests` or `skipFailedRequests` is set to true.\n\t */\n\treadonly requestWasSuccessful: ValueDeterminingMiddleware<boolean>\n\n\t/**\n\t * Method to generate custom identifiers for clients.\n\t *\n\t * By default, the client's IP address is used.\n\t */\n\treadonly keyGenerator: ValueDeterminingMiddleware<string>\n\n\t/**\n\t * Method (in the form of middleware) to determine whether or not this request\n\t * counts towards a client's quota.\n\t */\n\treadonly skip: ValueDeterminingMiddleware<boolean>\n\n\t/**\n\t * Express request handler that sends back a response when a client is\n\t * rate-limited.\n\t */\n\treadonly handler: RateLimitExceededEventHandler\n\n\t/**\n\t * Express request handler that sends back a response when a client has\n\t * reached their rate limit, and will be rate limited on their next request.\n\t */\n\treadonly onLimitReached: RateLimitReachedEventHandler\n\n\t/**\n\t * The {@link Store} to use to store the hit count for each client.\n\t */\n\tstore: Store\n\n\t/**\n\t * Whether to send `X-RateLimit-*` headers with the rate limit and the number\n\t * of requests.\n\t *\n\t * @deprecated 6.x - This option was renamed to `legacyHeaders`.\n\t */\n\theaders?: boolean\n\n\t/**\n\t * Whether to send `RateLimit-*` headers with the rate limit and the number\n\t * of requests.\n\t *\n\t * @deprecated 6.x - This option was renamed to `standardHeaders`.\n\t */\n\tdraft_polli_ratelimit_headers?: boolean\n}\n\n/**\n * The extended request object that includes information about the client's\n * rate limit.\n */\nexport type AugmentedRequest = Express.Request & {\n\t[key: string]: RateLimitInfo\n}\n\n/**\n * The rate limit related information for each client included in the\n * Express request object.\n */\nexport interface RateLimitInfo {\n\treadonly limit: number\n\treadonly current: number\n\treadonly remaining: number\n\treadonly resetTime: Date | undefined\n}\n"]}

package/dist/esm/index.d.ts

@@ -1,2 +0,0 @@
-export * from './types.js';
-export { default } from './lib.js';

package/dist/esm/index.js

@@ -1,5 +0,0 @@
-// /source/index.ts
-// Export away!
-export * from './types.js';
-export { default } from './lib.js';
-//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/index.ts"],"names":[],"mappings":"AAAA,mBAAmB;AACnB,eAAe;AAEf,cAAc,YAAY,CAAA;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA","sourcesContent":["// /source/index.ts\n// Export away!\n\nexport * from './types.js'\nexport { default } from './lib.js'\n"]}

package/dist/esm/lib.d.ts

@@ -1,15 +0,0 @@
-import { Options, RateLimitRequestHandler, LegacyStore, Store } from './types.js';
-/**
- *
- * Create an instance of IP rate-limiting middleware for Express.
- *
- * @param passedOptions {Options} - Options to configure the rate limiter
- *
- * @returns {RateLimitRequestHandler} - The middleware that rate-limits clients based on your configuration
- *
- * @public
- */
-declare const rateLimit: (passedOptions?: (Omit<Partial<Options>, "store"> & {
-    store?: LegacyStore | Store | undefined;
-}) | undefined) => RateLimitRequestHandler;
-export default rateLimit;

package/dist/esm/lib.js

@@ -1,361 +0,0 @@
-// /source/lib.ts
-// The option parser and rate limiting middleware
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __generator = (this && this.__generator) || function (thisArg, body) {
-    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
-    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
-    function verb(n) { return function (v) { return step([n, v]); }; }
-    function step(op) {
-        if (f) throw new TypeError("Generator is already executing.");
-        while (_) try {
-            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
-            if (y = 0, t) op = [op[0] & 2, t.value];
-            switch (op[0]) {
-                case 0: case 1: t = op; break;
-                case 4: _.label++; return { value: op[1], done: false };
-                case 5: _.label++; y = op[1]; op = [0]; continue;
-                case 7: op = _.ops.pop(); _.trys.pop(); continue;
-                default:
-                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
-                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
-                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
-                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
-                    if (t[2]) _.ops.pop();
-                    _.trys.pop(); continue;
-            }
-            op = body.call(thisArg, _);
-        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
-        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
-    }
-};
-import MemoryStore from './memory-store.js';
-/**
- * Type guard to check if a store is legacy store.
- *
- * @param store {LegacyStore | Store} - The store to check
- *
- * @return {boolean} - Whether the store is a legacy store
- */
-var isLegacyStore = function (store) {
-    // Check that `incr` exists but `increment` does not - store authors might want
-    // to keep both around for backwards compatibility.
-    return typeof store.incr === 'function' &&
-        typeof store.increment !== 'function';
-};
-/**
- * Converts a legacy store to the promisified version.
- *
- * @param store {LegacyStore | Store} - The legacy store or even a modern store
- *
- * @returns {Store} - The promisified version of the store
- */
-var promisifyStore = function (passedStore) {
-    if (!isLegacyStore(passedStore)) {
-        // It's not an old store, return as is
-        return passedStore;
-    }
-    // Why can't Typescript understand this?
-    var legacyStore = passedStore;
-    // A promisified version of the store
-    var PromisifiedStore = /** @class */ (function () {
-        function PromisifiedStore() {
-        }
-        PromisifiedStore.prototype.increment = function (key) {
-            return __awaiter(this, void 0, void 0, function () {
-                return __generator(this, function (_a) {
-                    return [2 /*return*/, new Promise(function (resolve, reject) {
-                            legacyStore.incr(key, function (error, totalHits, resetTime) {
-                                if (error)
-                                    reject(error);
-                                resolve({ totalHits: totalHits, resetTime: resetTime });
-                            });
-                        })];
-                });
-            });
-        };
-        PromisifiedStore.prototype.decrement = function (key) {
-            return __awaiter(this, void 0, void 0, function () {
-                return __generator(this, function (_a) {
-                    return [2 /*return*/, Promise.resolve(legacyStore.decrement(key))];
-                });
-            });
-        };
-        PromisifiedStore.prototype.resetKey = function (key) {
-            return __awaiter(this, void 0, void 0, function () {
-                return __generator(this, function (_a) {
-                    return [2 /*return*/, Promise.resolve(legacyStore.resetKey(key))];
-                });
-            });
-        };
-        PromisifiedStore.prototype.resetAll = function () {
-            return __awaiter(this, void 0, void 0, function () {
-                return __generator(this, function (_a) {
-                    if (typeof legacyStore.resetAll === 'function')
-                        return [2 /*return*/, Promise.resolve(legacyStore.resetAll())];
-                    return [2 /*return*/];
-                });
-            });
-        };
-        return PromisifiedStore;
-    }());
-    return new PromisifiedStore();
-};
-/**
- * Adds the defaults for options the user has not specified.
- *
- * @param options {Options} - The options the user specifies
- *
- * @returns {Options} - A complete configuration object
- */
-var parseOptions = function (passedOptions) {
-    // Now add the defaults for the other options
-    var _a, _b;
-    var options = __assign({ windowMs: 60 * 1000, store: new MemoryStore(), max: 5, message: 'Too many requests, please try again later.', statusCode: 429, legacyHeaders: (_a = passedOptions.headers) !== null && _a !== void 0 ? _a : true, standardHeaders: (_b = passedOptions.draft_polli_ratelimit_headers) !== null && _b !== void 0 ? _b : false, requestPropertyName: 'rateLimit', skipFailedRequests: false, skipSuccessfulRequests: false, requestWasSuccessful: function (_request, response) { return response.statusCode < 400; }, skip: function (_request, _response) {
-            return false;
-        }, keyGenerator: function (request, _response) {
-            if (!request.ip) {
-                console.error('WARN | `express-rate-limit` | `request.ip` is undefined. You can avoid this by providing a custom `keyGenerator` function, but it may be indicative of a larger issue.');
-            }
-            return request.ip;
-        }, handler: function (_request, response, _next, _optionsUsed) {
-            response.status(options.statusCode).send(options.message);
-        }, onLimitReached: function (_request, _response, _optionsUsed) { } }, passedOptions);
-    // Ensure that the store passed implements the either the `Store` or `LegacyStore`
-    // interface
-    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')) {
-        throw new TypeError('An invalid store was passed. Please ensure that the store is a class that implements the `Store` interface.');
-    }
-    // Promisify the store, if it is not already
-    options.store = promisifyStore(options.store);
-    // Return the 'clean' options
-    return options;
-};
-/**
- * Just pass on any errors for the developer to handle, usually as a HTTP 500
- * Internal Server Error.
- *
- * @param fn {Express.RequestHandler} - The request handler for which to handle errors
- *
- * @returns {Express.RequestHandler} - The request handler wrapped with a `.catch` clause
- *
- * @private
- */
-var handleAsyncErrors = function (fn) {
-    return function (request, response, next) { return __awaiter(void 0, void 0, void 0, function () {
-        var error_1;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    _a.trys.push([0, 2, , 3]);
-                    return [4 /*yield*/, Promise.resolve(fn(request, response, next))["catch"](next)];
-                case 1:
-                    _a.sent();
-                    return [3 /*break*/, 3];
-                case 2:
-                    error_1 = _a.sent();
-                    next(error_1);
-                    return [3 /*break*/, 3];
-                case 3: return [2 /*return*/];
-            }
-        });
-    }); };
-};
-/**
- *
- * Create an instance of IP rate-limiting middleware for Express.
- *
- * @param passedOptions {Options} - Options to configure the rate limiter
- *
- * @returns {RateLimitRequestHandler} - The middleware that rate-limits clients based on your configuration
- *
- * @public
- */
-var rateLimit = function (passedOptions) {
-    // Parse the options and add the default values for unspecified options
-    var options = parseOptions(passedOptions !== null && passedOptions !== void 0 ? passedOptions : {});
-    // Call the `init` method on the store, if it exists
-    if (typeof options.store.init === 'function')
-        options.store.init(options);
-    // Then return the actual middleware
-    var middleware = handleAsyncErrors(function (request, response, next) { return __awaiter(void 0, void 0, void 0, function () {
-        var skip, augmentedRequest, key, _a, totalHits, resetTime, retrieveQuota, maxHits, deltaSeconds, decremented_1, decrementKey_1;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0: return [4 /*yield*/, options.skip(request, response)];
-                case 1:
-                    skip = _b.sent();
-                    if (skip) {
-                        next();
-                        return [2 /*return*/];
-                    }
-                    augmentedRequest = request;
-                    return [4 /*yield*/, options.keyGenerator(request, response)
-                        // Increment the client's hit counter by one
-                    ];
-                case 2:
-                    key = _b.sent();
-                    return [4 /*yield*/, options.store.increment(key)
-                        // Get the quota (max number of hits) for each client
-                    ];
-                case 3:
-                    _a = _b.sent(), totalHits = _a.totalHits, resetTime = _a.resetTime;
-                    retrieveQuota = typeof options.max === 'function'
-                        ? options.max(request, response)
-                        : options.max;
-                    return [4 /*yield*/, retrieveQuota
-                        // Set the rate limit information on the augmented request object
-                    ];
-                case 4:
-                    maxHits = _b.sent();
-                    // Set the rate limit information on the augmented request object
-                    augmentedRequest[options.requestPropertyName] = {
-                        limit: maxHits,
-                        current: totalHits,
-                        remaining: Math.max(maxHits - totalHits, 0),
-                        resetTime: resetTime
-                    };
-                    // Set the X-RateLimit headers on the response object if enabled
-                    if (options.legacyHeaders && !response.headersSent) {
-                        response.setHeader('X-RateLimit-Limit', maxHits);
-                        response.setHeader('X-RateLimit-Remaining', augmentedRequest[options.requestPropertyName].remaining);
-                        // If we have a resetTime, also provide the current date to help avoid issues with incorrect clocks
-                        if (resetTime instanceof Date) {
-                            response.setHeader('Date', new Date().toUTCString());
-                            response.setHeader('X-RateLimit-Reset', Math.ceil(resetTime.getTime() / 1000));
-                        }
-                    }
-                    // Set the standardized RateLimit headers on the response object
-                    // if enabled
-                    if (options.standardHeaders && !response.headersSent) {
-                        response.setHeader('RateLimit-Limit', maxHits);
-                        response.setHeader('RateLimit-Remaining', augmentedRequest[options.requestPropertyName].remaining);
-                        if (resetTime) {
-                            deltaSeconds = Math.ceil((resetTime.getTime() - Date.now()) / 1000);
-                            response.setHeader('RateLimit-Reset', Math.max(0, deltaSeconds));
-                        }
-                    }
-                    // If we are to skip failed/successfull requests, decrement the
-                    // counter accordingly once we know the status code of the request
-                    if (options.skipFailedRequests || options.skipSuccessfulRequests) {
-                        decremented_1 = false;
-                        decrementKey_1 = function () { return __awaiter(void 0, void 0, void 0, function () {
-                            return __generator(this, function (_a) {
-                                switch (_a.label) {
-                                    case 0:
-                                        if (!!decremented_1) return [3 /*break*/, 2];
-                                        return [4 /*yield*/, options.store.decrement(key)];
-                                    case 1:
-                                        _a.sent();
-                                        decremented_1 = true;
-                                        _a.label = 2;
-                                    case 2: return [2 /*return*/];
-                                }
-                            });
-                        }); };
-                        if (options.skipFailedRequests) {
-                            response.on('finish', function () { return __awaiter(void 0, void 0, void 0, function () {
-                                return __generator(this, function (_a) {
-                                    switch (_a.label) {
-                                        case 0:
-                                            if (!!options.requestWasSuccessful(request, response)) return [3 /*break*/, 2];
-                                            return [4 /*yield*/, decrementKey_1()];
-                                        case 1:
-                                            _a.sent();
-                                            _a.label = 2;
-                                        case 2: return [2 /*return*/];
-                                    }
-                                });
-                            }); });
-                            response.on('close', function () { return __awaiter(void 0, void 0, void 0, function () {
-                                return __generator(this, function (_a) {
-                                    switch (_a.label) {
-                                        case 0:
-                                            if (!!response.writableEnded) return [3 /*break*/, 2];
-                                            return [4 /*yield*/, decrementKey_1()];
-                                        case 1:
-                                            _a.sent();
-                                            _a.label = 2;
-                                        case 2: return [2 /*return*/];
-                                    }
-                                });
-                            }); });
-                            response.on('error', function () { return __awaiter(void 0, void 0, void 0, function () {
-                                return __generator(this, function (_a) {
-                                    switch (_a.label) {
-                                        case 0: return [4 /*yield*/, decrementKey_1()];
-                                        case 1:
-                                            _a.sent();
-                                            return [2 /*return*/];
-                                    }
-                                });
-                            }); });
-                        }
-                        if (options.skipSuccessfulRequests) {
-                            response.on('finish', function () { return __awaiter(void 0, void 0, void 0, function () {
-                                return __generator(this, function (_a) {
-                                    switch (_a.label) {
-                                        case 0:
-                                            if (!options.requestWasSuccessful(request, response)) return [3 /*break*/, 2];
-                                            return [4 /*yield*/, decrementKey_1()];
-                                        case 1:
-                                            _a.sent();
-                                            _a.label = 2;
-                                        case 2: return [2 /*return*/];
-                                    }
-                                });
-                            }); });
-                        }
-                    }
-                    // Call the {@link Options.onLimitReached} callback on
-                    // the first request where client exceeds their rate limit.
-                    if (maxHits && totalHits === maxHits + 1) {
-                        options.onLimitReached(request, response, options);
-                    }
-                    // If the client has exceeded their rate limit, set the Retry-After
-                    // header and call the {@link Options.handler} function
-                    if (maxHits && totalHits > maxHits) {
-                        if ((options.legacyHeaders || options.standardHeaders) &&
-                            !response.headersSent) {
-                            response.setHeader('Retry-After', Math.ceil(options.windowMs / 1000));
-                        }
-                        options.handler(request, response, next, options);
-                        return [2 /*return*/];
-                    }
-                    next();
-                    return [2 /*return*/];
-            }
-        });
-    }); });
-    middleware.resetKey =
-        options.store.resetKey.bind(options.store);
-    return middleware;
-};
-// Export it to the world!
-export default rateLimit;
-//# sourceMappingURL=lib.js.map