Skip to content

Commit 1b4babb

Browse files
authored
docs(readme): replace fastify.io links with fastify.dev (#358)
1 parent a08bf38 commit 1b4babb

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ In case a client reaches the maximum number of allowed requests, an error will b
5555
message: 'Rate limit exceeded, retry in 1 minute'
5656
}
5757
```
58-
You can change the response by providing a callback to `errorResponseBuilder` or setting a [custom error handler](https://www.fastify.io/docs/latest/Reference/Server/#seterrorhandler):
58+
You can change the response by providing a callback to `errorResponseBuilder` or setting a [custom error handler](https://fastify.dev/docs/latest/Reference/Server/#seterrorhandler):
5959

6060
```js
6161
fastify.setErrorHandler(function (error, request, reply) {
@@ -151,7 +151,7 @@ await fastify.register(import('@fastify/rate-limit'), {
151151
- `continueExceeding`: Renew user limitation when user sends a request to the server when still limited
152152
- `store`: a custom store to track requests and rates which allows you to use your own storage mechanism (using an RDBMS, MongoDB, etc.) as well as further customizing the logic used in calculating the rate limits. A simple example is provided below as well as a more detailed example using Knex.js can be found in the [`example/`](https://github.com/fastify/fastify-rate-limit/tree/master/example) folder
153153
- `skipOnError`: if `true` it will skip errors generated by the storage (e.g. redis not reachable).
154-
- `keyGenerator`: a sync or async function to generate a unique identifier for each incoming request. Defaults to `(request) => request.ip`, the IP is resolved by fastify using `request.connection.remoteAddress` or `request.headers['x-forwarded-for']` if [trustProxy](https://www.fastify.io/docs/latest/Reference/Server/#trustproxy) option is enabled. Use it if you want to override this behavior
154+
- `keyGenerator`: a sync or async function to generate a unique identifier for each incoming request. Defaults to `(request) => request.ip`, the IP is resolved by fastify using `request.connection.remoteAddress` or `request.headers['x-forwarded-for']` if [trustProxy](https://fastify.dev/docs/latest/Reference/Server/#trustproxy) option is enabled. Use it if you want to override this behavior
155155
- `errorResponseBuilder`: a function to generate a custom response object. Defaults to `(request, context) => ({statusCode: 429, error: 'Too Many Requests', message: ``Rate limit exceeded, retry in ${context.after}``})`
156156
- `addHeadersOnExceeding`: define which headers should be added in the response when the limit is not reached. Defaults all the headers will be shown
157157
- `addHeaders`: define which headers should be added in the response when the limit is reached. Defaults all the headers will be shown

0 commit comments

Comments
 (0)