express-rate-limit 7.0.0 → 7.0.1

package/changelog.md

@@ -6,6 +6,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [7.0.1](https://github.com/express-rate-limit/express-rate-limit/releases/tag/v7.0.1)
+
+### Added
+
+- Added `rate-limit-postgresql` to the `stores` list in the readme.
+
 ## [7.0.0](https://github.com/express-rate-limit/express-rate-limit/releases/tag/v7.0.0)
 
 ### Breaking

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "express-rate-limit",
-	"version": "7.0.0",
+	"version": "7.0.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",
@@ -76,28 +76,28 @@
 		"express": "^4 || ^5"
 	},
 	"devDependencies": {
-    "@express-rate-limit/prettier": "1.1.0",
-    "@express-rate-limit/tsconfig": "1.0.0",
-    "@jest/globals": "29.6.4",
-    "@types/express": "4.17.17",
-    "@types/jest": "29.5.4",
-    "@types/node": "20.5.9",
-    "@types/supertest": "2.0.12",
-    "cross-env": "7.0.3",
-    "del-cli": "5.1.0",
-    "dts-bundle-generator": "8.0.1",
-    "esbuild": "0.19.2",
-    "express": "4.18.2",
-    "husky": "8.0.3",
-    "jest": "29.6.4",
-    "lint-staged": "14.0.1",
-    "npm-run-all": "4.1.5",
-    "ratelimit-header-parser": "0.1.0",
-    "supertest": "6.3.3",
-    "ts-jest": "29.1.1",
-    "ts-node": "10.9.1",
-    "typescript": "5.2.2",
-    "xo": "0.56.0"
+		"@express-rate-limit/prettier": "1.1.0",
+		"@express-rate-limit/tsconfig": "1.0.0",
+		"@jest/globals": "29.6.4",
+		"@types/express": "4.17.17",
+		"@types/jest": "29.5.4",
+		"@types/node": "20.5.9",
+		"@types/supertest": "2.0.12",
+		"cross-env": "7.0.3",
+		"del-cli": "5.1.0",
+		"dts-bundle-generator": "8.0.1",
+		"esbuild": "0.19.2",
+		"express": "4.18.2",
+		"husky": "8.0.3",
+		"jest": "29.6.4",
+		"lint-staged": "14.0.1",
+		"npm-run-all": "4.1.5",
+		"ratelimit-header-parser": "0.1.0",
+		"supertest": "6.3.3",
+		"ts-jest": "29.1.1",
+		"ts-node": "10.9.1",
+		"typescript": "5.2.2",
+		"xo": "0.56.0"
 	},
 	"xo": {
 		"prettier": true,

package/readme.md

@@ -422,17 +422,6 @@ const limiter = rateLimit({
 })
 ```
 
-### `onLimitReached`
-
-> `function`
-
-A (sync/async) function that accepts the Express `req` and `res` objects that is
-called the on the request where a client has just exceeded their rate limit.
-
-This method was
-[deprecated in v6](https://github.com/express-rate-limit/express-rate-limit/releases/v6.0.0) -
-Please use a custom `handler` that checks the number of hits instead.
-
 ### `skip`
 
 > `function`
@@ -531,6 +520,7 @@ Here is a list of external stores:
 | [`rate-limit-memcached`](https://npmjs.org/package/rate-limit-memcached)               | A [Memcached](https://memcached.org/)-backed store.                                                   | Legacy              |
 | [`rate-limit-mongo`](https://www.npmjs.com/package/rate-limit-mongo)                   | A [MongoDB](https://www.mongodb.com/)-backed store.                                                   | Legacy              |
 | [`precise-memory-rate-limit`](https://www.npmjs.com/package/precise-memory-rate-limit) | A memory store similar to the built-in one, except that it stores a distinct timestamp for each key.  | Modern as of v2.0.0 |
+| [`rate-limit-postgresql`](https://www.npmjs.com/package/@acpr/rate-limit-postgresql)   | A [PostgreSQL](https://www.postgresql.org/)-backed store.                                             | Modern as of v1.1.0 |
 
 Take a look at
 [this guide](https://github.com/express-rate-limit/express-rate-limit/wiki/Creating-Your-Own-Store)
@@ -553,8 +543,11 @@ The property name can be configured with the configuration option
 ### `resetKey(key)`
 
 Resets the rate limiting for a given key. An example use case is to allow users
-to complete a captcha or whatever to reset their rate limit, then call this
-method.
+to complete a captcha to reset their rate limit, then call this function.
+
+### `getKey(key)`
+
+Retrieves the hit count and reset time from the store for a given key.
 
 ## Issues and Contributing