Declare correct ws options type (#338)

hapijs · Jan 8, 2025 · ccf86f9 · ccf86f9
1 parent c627a42
commit ccf86f9
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 3 deletions.
diff --git a/lib/client.d.ts b/lib/client.d.ts
@@ -1,3 +1,6 @@
+import type { ClientRequestArgs } from "http";
+import type { ClientOptions } from "ws";
+
 // Same as exported type in @hapi/hapi v20
 type HTTP_METHODS = 'ACL' | 'BIND' | 'CHECKOUT' | 'CONNECT' | 'COPY' | 'DELETE' | 'GET' | 'HEAD' | 'LINK' | 'LOCK' |
     'M-SEARCH' | 'MERGE' | 'MKACTIVITY' | 'MKCALENDAR' | 'MKCOL' | 'MOVE' | 'NOTIFY' | 'OPTIONS' | 'PATCH' | 'POST' |
@@ -173,7 +176,7 @@ export class Client {
     constructor(
         url: `ws://${string}` | `wss://${string}`,
         options?: {
-            ws?: string | string[];
+            ws?: ClientOptions | ClientRequestArgs;
             timeout?: number | boolean;
         });
 
@@ -369,4 +372,4 @@ export class Client {
      * `client.connect()`
      */
     reauthenticate(auth: ClientConnectOptions['auth']): Promise<unknown>;
-}
+}
diff --git a/package.json b/package.json
@@ -25,6 +25,7 @@
     "@hapi/iron": "^7.0.1",
     "@hapi/teamwork": "^6.0.0",
     "@hapi/validate": "^2.0.1",
+    "@types/ws": "^8.5.13",
     "ws": "^8.18.0"
   },
   "devDependencies": {

diff --git a/test/types/client.ts b/test/types/client.ts
@@ -7,7 +7,13 @@ import { Client } from '../../lib/client';
 
 const init = () => {
 
-    const client = new Client('ws://localhost');
+    const client = new Client('ws://localhost', {
+        ws: { // optional
+            origin: 'http://localhost:12345',
+            maxPayload: 1000,
+            headers: { cookie: 'xnes=123' }
+        }
+    });
 
     client.connect()