documentation: types

ArnaudBuchholz · May 14, 2024 · 90ae9c1 · 90ae9c1
1 parent 41ab79a
commit 90ae9c1
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 4 deletions.
diff --git a/reserve/@types/index.d.ts b/reserve/@types/index.d.ts
@@ -131,7 +131,6 @@ declare module 'reserve' {
 
   // endregion use
 
-
   // region helpers
 
   function log (server: Server, verbose?: boolean): Server
@@ -151,8 +150,6 @@ declare module 'reserve' {
 
   function body (request: IncomingMessage, options?: BodyOptions): BodyResult
 
-  function capture (response: ServerResponse, stream: WritableStream): Promise<void>
-
   interface SendOptions {
     statusCode?: number /* defaulted to 200 */
     headers?: Headers
@@ -162,6 +159,23 @@ declare module 'reserve' {
   function send (response: ServerResponse, data: ReadableStream, options?: SendOptions): Promise<void>
   function send (response: ServerResponse, data?: string | object, options?: SendOptions): void
 
+  function capture (response: ServerResponse, stream: WritableStream): Promise<void>
+
+  interface PunycacheOptions {
+    ttl?: number
+    max?: number
+    policy?: 'lru' | 'lfu'
+  }
+
+  interface PunycacheCache {
+    set (key: string, value: any): void
+    get (key: string): any
+    del (key: string): void
+    keys (): string[]
+  }
+
+  function punycache (options?: PunycacheOptions): PunycacheCache
+
   // endregion helpers
 
   interface SSLSettings {

diff --git a/reserve/CHANGELOG.md b/reserve/CHANGELOG.md
@@ -31,7 +31,7 @@
 ||`static` option for performant `file` delivery ([`doc`](file.md))|
 ||Expose `send` helper ([doc](send.md))|
 ||Expose `punycache` helper ([doc](https://www.npmjs.com/package/punycache))|
-||Fix types definition (`use` handler)|
+||Fix types definitions|
 |1.15.9|Documentation update|
 |1.15.8|Fix types definition (UseMapping)|
 |1.15.7|Fix types definition (UseMapping)|