Update responseMessage type (#5)

* Update responseMessage type * Update README.md * chore: changeset --------- Co-authored-by: Phumrapee Limpianchop <[email protected]>
rayriffy · Nov 26, 2023 · d84ebbd · d84ebbd
1 parent 68a1178
commit d84ebbd
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/.changeset/tricky-keys-vanish.md b/.changeset/tricky-keys-vanish.md
@@ -0,0 +1,5 @@
+---
+'elysia-rate-limit': patch
+---
+
+responseMessage type has been changed to `any`, so you can actually return response as anything (i.e. object)
diff --git a/README.md b/README.md
@@ -49,7 +49,7 @@ HTTP reponse code to be sent when rate limit was reached. By default, it will re
 
 ### responseMessage
 
-`string`
+`any`
 
 Default: `rate-limit reached`
 

diff --git a/src/@types/Options.ts b/src/@types/Options.ts
@@ -14,7 +14,7 @@ export interface Options {
   responseCode: number
 
   // message response when rate-limit reached (Default: rate-limit reached)
-  responseMessage: string
+  responseMessage: any
 
   // should rate limit being counted when request result is failed (Default: false)
   countFailedRequest: boolean