add response cookies type (#234)

* add response cookies type * add type checking * Update types/index.d.ts Co-authored-by: Uzlopak <aras.abbasi@googlemail.com> * Revert "Update types/index.d.ts" This reverts commit ed76688. * apply code review * code review Co-authored-by: Uzlopak <aras.abbasi@googlemail.com>
fastify · Dec 6, 2022 · 0c9d75c · 0c9d75c
1 parent be327ba
commit 0c9d75c
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 2 deletions.
diff --git a/types/index.d.ts b/types/index.d.ts
@@ -58,6 +58,20 @@ declare namespace inject {
     Request?: object,
   }
 
+  /**
+   * https://github.com/nfriedly/set-cookie-parser/blob/3eab8b7d5d12c8ed87832532861c1a35520cf5b3/lib/set-cookie.js#L41
+   */
+  interface Cookie {
+    name: string;
+    value: string;
+    expires?: Date;
+    maxAge?: number;
+    secure?: boolean;
+    httpOnly?: boolean;
+    sameSite?: string;
+    [name: string]: unknown
+  }
+
   export interface Response {
     raw: {
       res: http.ServerResponse,
@@ -71,7 +85,7 @@ declare namespace inject {
     payload: string
     body: string
     json: <T = any>() => T
-    cookies: Array<object>
+    cookies: Array<Cookie>
   }
 
   export interface Chain extends Promise<Response> {

diff --git a/types/index.test-d.ts b/types/index.test-d.ts
@@ -21,7 +21,16 @@ const expectResponse = function (res: Response) {
   expectAssignable<Function>(res.json)
   expectAssignable<http.ServerResponse>(res.raw.res)
   expectAssignable<http.IncomingMessage>(res.raw.req)
-  console.log(res.cookies)
+  expectAssignable<Array<any>>(res.cookies)
+  const cookie = res.cookies[0]
+  expectType<string>(cookie.name)
+  expectType<string>(cookie.value)
+  expectType<Date | undefined>(cookie.expires)
+  expectType<number | undefined>(cookie.maxAge)
+  expectType<boolean | undefined>(cookie.httpOnly)
+  expectType<boolean | undefined>(cookie.secure)
+  expectType<string | undefined>(cookie.sameSite)
+  expectType<unknown | undefined>(cookie.additional)
 }
 
 expectType<DispatchFunc>(dispatch)