feat(client): connectionParams can return undefined

enisdenjo · Jun 23, 2021 · a543187 · a543187
1 parent dd28295
commit a543187
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/docs/interfaces/client.clientoptions.md b/docs/interfaces/client.clientoptions.md
@@ -30,7 +30,7 @@ Configuration used for the GraphQL over WebSocket client.
 
 ### connectionParams
 
-• `Optional` **connectionParams**: `Record`<string, unknown\> \| () => `Record`<string, unknown\> \| `Promise`<Record<string, unknown\>\>
+• `Optional` **connectionParams**: `Record`<string, unknown\> \| () => `undefined` \| `Record`<string, unknown\> \| `Promise`<undefined \| Record<string, unknown\>\>
 
 Optional parameters, passed through the `payload` field with the `ConnectionInit` message,
 that the client specifies when establishing a connection with the server. You can use this

diff --git a/src/client.ts b/src/client.ts
@@ -11,6 +11,7 @@ import {
   Disposable,
   Message,
   MessageType,
+  ConnectionInitMessage,
   ConnectionAckMessage,
   PingMessage,
   PongMessage,
@@ -170,8 +171,10 @@ export interface ClientOptions {
    * in the close event reason.
    */
   connectionParams?:
-    | Record<string, unknown>
-    | (() => Promise<Record<string, unknown>> | Record<string, unknown>);
+    | ConnectionInitMessage['payload']
+    | (() =>
+        | Promise<ConnectionInitMessage['payload']>
+        | ConnectionInitMessage['payload']);
   /**
    * Controls when should the connection be established.
    *