Updated readme

fastify · Oct 28, 2024 · f4a2718 · f4a2718
1 parent 412f8a2
commit f4a2718
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -160,6 +160,7 @@ await fastify.register(import('@fastify/rate-limit'), {
 - `onExceeding`: callback that will be executed before request limit has been reached. 
 - `onExceeded`: callback that will be executed after request limit has been reached.
 - `onBanReach`: callback that will be executed when the ban limit has been reached.
+- `exponentialBackoff`: Renew user limitation exponentially when user sends a request to the server when still limited
 
 `keyGenerator` example usage:
 ```js

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -126,6 +126,8 @@ declare namespace fastifyRateLimit {
     enableDraftSpec?: boolean;
     onExceeding?: (req: FastifyRequest, key: string) => void;
     onExceeded?: (req: FastifyRequest, key: string) => void;
+    exponentialBackoff?: boolean;
+
   }
 
   export interface RateLimitPluginOptions extends RateLimitOptions {