docs: add note about the agent option

Related: #708
socketio · Sep 13, 2023 · 3dcb88c · 3dcb88c
1 parent 1097056
commit 3dcb88c
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/lib/socket.ts b/lib/socket.ts
@@ -39,6 +39,10 @@ export interface SocketOptions {
 
   /**
    * `http.Agent` to use, defaults to `false` (NodeJS only)
+   *
+   * Note: the type should be "undefined | http.Agent | https.Agent | false", but this would break browser-only clients.
+   *
+   * @see https://nodejs.org/api/http.html#httprequestoptions-callback
    */
   agent: string | boolean;