Option to control RateLimit-* headers (#46)

* feat: headers option

* refactor: types

* docs: readme

.changeset/mean-cougars-clap.md

@@ -0,0 +1,5 @@
+---
+'elysia-rate-limit': minor
+---
+
+added ability to let pligin not to send RateLimit-\* headers

README.md

@@ -212,6 +212,15 @@ new Elysia().use(
 )
 ```
 
+### headers
+
+`boolean`
+
+Default `true`
+
+Should this plugin automatically set `RateLimit-*` headers to the response?
+If you want to disable this feature, you can set this option to `false`.
+
 ### skip
 
 `(request: Request, key: string): boolean | Promise<boolean>`

src/@types/Options.ts

@@ -36,4 +36,8 @@ export interface Options {
   // since this function will slightly reduce server performance
   // (Default: not defined)
   injectServer?: () => Server | null
+
+  // let the plugin in control of RateLimit-* headers
+  // (Default: true)
+  headers: boolean
 }

src/constants/defaultOptions.ts

@@ -9,5 +9,6 @@ export const defaultOptions: Omit<Options, 'context'> = {
   scoping: 'global',
   countFailedRequest: false,
   generator: defaultKeyGenerator,
+  headers: true,
   skip: () => false,
 }

src/services/plugin.ts

@@ -78,15 +78,17 @@ export const plugin = (userOptions?: Partial<Options>) => {
             const clonedResponse = options.errorResponse.clone()
 
             // append headers
-            for (const [key, value] of Object.entries(builtHeaders))
-              clonedResponse.headers.set(key, value)
+            if (options.headers)
+              for (const [key, value] of Object.entries(builtHeaders))
+                clonedResponse.headers.set(key, value)
 
             return clonedResponse
           }
           else {
             // append headers
-            for (const [key, value] of Object.entries(builtHeaders))
-              set.headers[key] = value
+            if (options.headers)
+              for (const [key, value] of Object.entries(builtHeaders))
+                set.headers[key] = value
 
             // set default status code
             set.status = 429
@@ -96,8 +98,9 @@ export const plugin = (userOptions?: Partial<Options>) => {
         }
 
         // append headers
-        for (const [key, value] of Object.entries(builtHeaders))
-          set.headers[key] = value
+        if (options.headers)
+          for (const [key, value] of Object.entries(builtHeaders))
+            set.headers[key] = value
 
         logger('plugin', 'clientKey %s passed through with %d/%d request used (resetting in %d seconds)', clientKey, options.max - payload.remaining, options.max, reset)
       }