diff options
author | Surma <surma@surma.dev> | 2022-02-13 13:47:46 +0000 |
---|---|---|
committer | GitHub <noreply@github.com> | 2022-02-13 14:47:46 +0100 |
commit | 5e845442fade02cd12d13e74222b26e217c5971d (patch) | |
tree | 6ac69c8104773995d3646974b8e87d657898bf00 /ext/websocket/lib.deno_websocket.d.ts | |
parent | a5d204d425c69809b82309325ac65113fb876b54 (diff) |
docs(websockets): add comment about Deno.upgradeWebSocket() for WebSocket servers (#13659)
Diffstat (limited to 'ext/websocket/lib.deno_websocket.d.ts')
-rw-r--r-- | ext/websocket/lib.deno_websocket.d.ts | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/ext/websocket/lib.deno_websocket.d.ts b/ext/websocket/lib.deno_websocket.d.ts index 81dcaffc0..af9026d41 100644 --- a/ext/websocket/lib.deno_websocket.d.ts +++ b/ext/websocket/lib.deno_websocket.d.ts @@ -34,7 +34,11 @@ interface WebSocketEventMap { open: Event; } -/** Provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection. */ +/** + * Provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection. + * + * If you are looking to create a WebSocket server, please take a look at Deno.upgradeWebSocket(). + */ declare class WebSocket extends EventTarget { constructor(url: string, protocols?: string | string[]); |