express-rate-limit

You can view the changelog here.

You can view the changelog here.

You can view the changelog here.

You can view the changelog here.

You can view the changelog here.

You can view the changelog here.

You can view the changelog here.

You can view the changelog here.

You can view the changelog here.

You can view the changelog here.

You can view the changelog here.

You can view the changelog here.

You can view the changelog here.

You can view the changelog here.

You can view the changelog here.

Changed

• Narrowed type of standardHeaders from string to just the supported values via a TypeScript const assertion (#506)

You can view the full changelog here.

Added

• Implemented the combined RateLimit header according to the eighth draft of the IETF RateLimit header specificiation. Enable by setting standardHeaders: 'draft-8'.
• Added a new identifier option, used as the name for the quota policy in the draft-8 headers.
• Added a new headersDraftVersion validation check to identifies cases where an unsupported version string is passed to the standardHeaders option.

You can view the full changelog here.

Fixed

• Made the passOnStoreError return after calling next() rather than continuing execution.

You can view the full changelog here.

Added

• Added passOnStoreError option to allow a way to "fail open" in the event of a backend error.

You can view the full changelog here.

Fixed

• Changed error displayed for the creationStack validation check when a store with localKeys set to false is used.
• Improved documentation for the creationStack check.

You can view the full changelog here.

Added

• Added a new unsharedStore validation check that identifies cases where a single store instance is shared across multiple limiters.

You can view the full changelog here.

Added

• Added a new creationStack validation check that looks for instances created in a request handler.

You can view the full changelog here.

Fixed

• Enable async requestWasSuccessful methods to work as documented.

You can view the full changelog here.

Fixed

• Ensure header values are strings rather than numbers, for compatibility with Bun.

You can view the full changelog here.

Changed

• Loosened peer dependencies to explicitly allow the Express 5 beta. (See #415)

You can view the full changelog here.

Changed

• Re-organized documentation from readme into docs/ folder and added documentation website.

You can view the full changelog here.

Misc

• Enabled provenance statement generation, see https://github.com/express-rate-limit/express-rate-limit#406.

You can view the full changelog here.

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.

You can view the full changelog here.

Added

• Added cluster-memory-store to the readme and made a couple of other minor clarifications.

You can view the full changelog here.

Added

• Added rate-limit-postgresql to the stores list in the readme.

You can view the full changelog here.

Breaking

• Changed behavior when max is set to 0:
  • Previously, max: 0 was treated as a 'disable' flag and would allow all requests through.
  • Starting with v7, all requests will be blocked when max is set to 0.
  • To replicate the old behavior, use the skip function instead.
• Renamed req.rateLimit.current to req.rateLimit.used.
  • current is now a hidden getter that will return the used value, but it will not appear when iterating over the keys or calling JSON.stringify().
• Changed the minimum required Node version from v14 to v16.
  • express-rate-limit now targets es2022 in TypeScript/ESBuild.
• Bumped TypeScript from v4 to v5 and dts-bundle-generator from v7 to v8.

Deprecated

• Removed the draft_polli_ratelimit_headers option (it was deprecated in v6).
  • Use standardHeaders: 'draft-6' instead.
• Removed the onLimitReached option (it was deprecated in v6).
  • This is an example of how to replicate it's behavior with a custom handler option.

Changed

• The MemoryStore now uses precise, per-user reset times rather than a global window that resets all users at once.
• The limit configuration option is now prefered to max.
  • It still shows the same behavior, and max is still supported. The change was made to better align with terminology used in the IETF standard drafts.

Added

• The validate config option can now be an object with keys to enable or disable specific validation checks. For more information, see this.

Fixed

• Restored IncrementResponse TypeScript type (See #397)

Fixed

• Check for prefixed keys when validating that the stores have single counted keys (See #395).

Added

• Support for retrieving the current hit count and reset time for a given key from a store (See #390).

Added

• Support for combined RateLimit header from the RateLimit header fields for HTTP standardization draft adopted by the IETF. Enable by setting standardHeaders: 'draft-7'
• New standardHeaders: 'draft-6' option, treated equivalent to standardHeaders: true from previous releases. (true and false are still supported.)
• New RateLimit-Policy header added when standardHeaders is set to 'draft-6', 'draft-7', or true
• Warning when using deprecated draft_polli_ratelimit_headers option
• Warning when using deprecated onLimitReached option
• Warning when totalHits value returned from Store is invalid

Added

• New validaion check for double-counted requests
• Added help link to each ValidationError, directing users to the appropriate wiki page for more info

Changed

• Miscaleanous documenation improvements

You can view the full changelog here.

Changed

• Revert 6.7.1 change that bumped typescript from 5.x to 4.x and dts-bundle-generator from 8.x to 7.x (See #360)

You can view the full changelog here.

Added

• Added a set of validation checks that will log an error if failed. See https://github.com/express-rate-limit/express-rate-limit/wiki/Error-Codes for a list of potential errors. Can be disabled by setting validate: false in the configuration. Automatically disables after the first request. (See #358)

You can view the changelog here.

(Backport of v6.8.1)

You can view the full changelog here.

Fixed

• Fixed compatibility with TypeScript's TypeScript new node16 module resolution strategy (See #355)

Changed

• Bumped development dependencies.
• Added node 20 to list of versions the CI jobs run on.

No functional changes.

You can view the changelog here.

No functional changes.

Changed

• Updated links to point to the new express-rate-limit organization on GitHub.
• Added advertisement to readme.md for project sponsor Zuplo.
• Updated to typescript version 5 and bumped other dependencies.
• Dropped node 12, and added node 19 to the list of versions the CI jobs run on.

You can view the changelog here.

Added

• Added shutdown method to the Store interface and the MemoryStore. (#322)

You can view the full changelog here.

Fixed

• Fixed an issue with missing types in ESM monorepos. (#321)

You can view the changelog here.

Changed

• The message option can now be a (sync/asynx) function that returns a value (#311)
• Updated all dependencies

Added

• Adds Express 5 (5.0.0-beta.1) as a supported peer dependency (#304)

Changed

• Tests are now run on Node 12, 14, 16 and 18 on CI (#305)
• Updated all development dependencies (#306)

Changed

• Changes the build target to es2019 so that ESBuild outputs code that can run with Node 12.
• Changes the minimum required Node version to 12.9.0.

Fixed

• Use the default value for an option when undefined is passed to the rate limiter.

Added

• Export the MemoryStore, so it can now be imported as a named import (import { MemoryStore } from 'express-rate-limit').

Fixed

• Deprecate the onLimitReached option (this was supposed to be deprecated in v6.0.0 itself); developers should use a custom handler function that checks if the rate limit has been exceeded instead.

Added

• Added a named export rateLimit in case the default import does not work.

Fixed

• Added a named export default, so Typescript CommonJS developers can default-import the library (import rateLimit from 'express-rate-limit').

Fixed

• Use named imports for ExpressJS types so users do not need to enable the esModuleInterop flag in their Typescript compiler configuration.

Fixed

• Upload the built package as a .tgz to GitHub releases.

Changed

• Add main and module fields to package.json. This helps tools such as ESLint that do not yet support the exports field.
• Bumped the minimum node.js version in package-lock.json to match package.json

Changed

• Bumped minimum Node version from 12.9 to 14.5 because the transpiled output uses the nullish coalescing operator (??), which isn't supported in Node prior to 14.x.

Fixed

• Ensure CommonJS projects can import the module.

Added

• Add additional tests that test:
  • importing the library in js-cjs, js-esm, ts-cjs, ts-esm environments.
  • usage of the library with external stores (redis, mongo, memcached, precise).

Changed

• Use esbuild to generate ESM and CJS output. This reduces the size of the built package from 138 kb to 13kb and build time to 4 ms! :rocket:
• Use dts-bundle-generator to generate a single Typescript declaration file.

Fixed

• Ensure CommonJS projects can import the module.

Added

• express 4.x as a peer dependency.
• Better Typescript support (the library was rewritten in Typescript).
• Export the package as both ESM and CJS.
• Publish the built package (.tgz file) on GitHub releases as well as the npm registry.
• Issue and PR templates.
• A contributing guide.
• A changelog.

Changed

• Rename the draft_polli_ratelimit_headers option to standardHeaders.
• Rename the headers option to legacyHeaders.
• Retry-After header is now sent if either legacyHeaders or standardHeaders is set.
• Allow keyGenerator to be an async function/return a promise.
• Change the way custom stores are defined.
  • Add the init method for stores to set themselves up using options passed to the middleware.
  • Rename the incr method to increment.
  • Allow the increment, decrement, resetKey and resetAll methods to return a promise.
  • Old stores will automatically be promisified and used.
• The package can now only be used with NodeJS version 12.9.0 or greater.
• The onLimitReached configuration option is now deprecated. Replace it with a custom handler that checks the number of hits.

Removed

• Remove the deprecated limiter.resetIp method (use the limiter.resetKey method instead).
• Remove the deprecated options delayMs, delayAfter (the delay functionality was moved to the express-slow-down package) and global (use a key generator that returns a constant value).