nfriedly/express-rate-limit
### [`v6.4.0`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#640-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv630)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.3.0...v6.4.0)
##### Added
- Adds Express 5 (`5.0.0-beta.1`) as a supported peer dependency ([#304](https://togithub.com/nfriedly/express-rate-limit/issues/304))
### [`v6.3.0`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#630-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv630)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.2.1...v6.3.0)
##### 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.
### [`v6.2.1`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#621-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv621)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.2.0...v6.2.1)
##### Fixed
- Use the default value for an option when `undefined` is passed to the rate
limiter.
### [`v6.2.0`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#620-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv620)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.1.0...v6.2.0)
##### 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.
### [`v6.1.0`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#610-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv610)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.0.5...v6.1.0)
##### 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'`).
### [`v6.0.5`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#605-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv605)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.0.4...v6.0.5)
##### Fixed
- Use named imports for ExpressJS types so users do not need to enable the
`esModuleInterop` flag in their Typescript compiler configuration.
### [`v6.0.4`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#604-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv604)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.0.3...v6.0.4)
##### 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`
### [`v6.0.3`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#603-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv603)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.0.2...v6.0.3)
##### Changed
- Bumped minimum Node version from 12.9 to 14.5 in `package.json` because the
transpiled output uses the nullish coalescing operator (`??`), which
[isn't supported in node.js prior to 14.x](https://node.green/#ES2020-features--nullish-coalescing-operator-----).
### [`v6.0.2`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#602-httpsgithubcomnfriedlyexpress-rate-limitreleasesv602)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.0.1...v6.0.2)
##### 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`](https://esbuild.github.io/) 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`](https://togithub.com/timocov/dts-bundle-generator)
to generate a single Typescript declaration file.
### [`v6.0.1`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#601-httpsgithubcomnfriedlyexpress-rate-limitreleasesv601)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.0.0...v6.0.1)
##### Fixed
- Ensure CommonJS projects can import the module.
### [`v6.0.0`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#600-httpsgithubcomnfriedlyexpress-rate-limitreleasesv600)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v5.5.1...v6.0.0)
##### 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.
##### 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`](https://togithub.com/nfriedly/express-slow-down) package)
and `global` (use a key generator that returns a constant value).
### [`v5.5.1`](https://togithub.com/nfriedly/express-rate-limit/compare/v5.5.0...v5.5.1)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v5.5.0...v5.5.1)
### [`v5.5.0`](https://togithub.com/nfriedly/express-rate-limit/compare/v5.4.1...v5.5.0)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v5.4.1...v5.5.0)
### [`v5.4.1`](https://togithub.com/nfriedly/express-rate-limit/compare/v5.4.0...v5.4.1)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v5.4.0...v5.4.1)
### [`v5.4.0`](https://togithub.com/nfriedly/express-rate-limit/compare/v5.3.0...v5.4.0)
[Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v5.3.0...v5.4.0)
Configuration
📅 Schedule: At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
[ ] If you want to rebase/retry this PR, click this checkbox.
This PR contains the following updates:
5.3.0->6.4.0Release Notes
nfriedly/express-rate-limit
### [`v6.4.0`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#640-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv630) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.3.0...v6.4.0) ##### Added - Adds Express 5 (`5.0.0-beta.1`) as a supported peer dependency ([#304](https://togithub.com/nfriedly/express-rate-limit/issues/304)) ### [`v6.3.0`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#630-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv630) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.2.1...v6.3.0) ##### 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. ### [`v6.2.1`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#621-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv621) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.2.0...v6.2.1) ##### Fixed - Use the default value for an option when `undefined` is passed to the rate limiter. ### [`v6.2.0`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#620-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv620) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.1.0...v6.2.0) ##### 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. ### [`v6.1.0`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#610-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv610) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.0.5...v6.1.0) ##### 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'`). ### [`v6.0.5`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#605-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv605) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.0.4...v6.0.5) ##### Fixed - Use named imports for ExpressJS types so users do not need to enable the `esModuleInterop` flag in their Typescript compiler configuration. ### [`v6.0.4`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#604-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv604) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.0.3...v6.0.4) ##### 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` ### [`v6.0.3`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#603-httpsgithubcomnfriedlyexpress-rate-limitreleasestagv603) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.0.2...v6.0.3) ##### Changed - Bumped minimum Node version from 12.9 to 14.5 in `package.json` because the transpiled output uses the nullish coalescing operator (`??`), which [isn't supported in node.js prior to 14.x](https://node.green/#ES2020-features--nullish-coalescing-operator-----). ### [`v6.0.2`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#602-httpsgithubcomnfriedlyexpress-rate-limitreleasesv602) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.0.1...v6.0.2) ##### 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`](https://esbuild.github.io/) 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`](https://togithub.com/timocov/dts-bundle-generator) to generate a single Typescript declaration file. ### [`v6.0.1`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#601-httpsgithubcomnfriedlyexpress-rate-limitreleasesv601) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v6.0.0...v6.0.1) ##### Fixed - Ensure CommonJS projects can import the module. ### [`v6.0.0`](https://togithub.com/nfriedly/express-rate-limit/blob/HEAD/changelog.md#600-httpsgithubcomnfriedlyexpress-rate-limitreleasesv600) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v5.5.1...v6.0.0) ##### 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. ##### 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`](https://togithub.com/nfriedly/express-slow-down) package) and `global` (use a key generator that returns a constant value). ### [`v5.5.1`](https://togithub.com/nfriedly/express-rate-limit/compare/v5.5.0...v5.5.1) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v5.5.0...v5.5.1) ### [`v5.5.0`](https://togithub.com/nfriedly/express-rate-limit/compare/v5.4.1...v5.5.0) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v5.4.1...v5.5.0) ### [`v5.4.1`](https://togithub.com/nfriedly/express-rate-limit/compare/v5.4.0...v5.4.1) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v5.4.0...v5.4.1) ### [`v5.4.0`](https://togithub.com/nfriedly/express-rate-limit/compare/v5.3.0...v5.4.0) [Compare Source](https://togithub.com/nfriedly/express-rate-limit/compare/v5.3.0...v5.4.0)Configuration
📅 Schedule: At any time (no schedule defined).
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR has been generated by WhiteSource Renovate. View repository job log here.