For AI agents: a documentation index is available at /llms.txt
Skip to main content

CreateWebSocketOptions

Options both platform bindings accept when opening a socket. Each is best-effort: the browser binding silently drops the ones the platform forbids, so callers must not rely on either being enforced.

Properties​

PropertyTypeDescription
handshakeTimeout?numberMilliseconds to wait for the opening handshake before failing the dial. Honored in Node (ws); ignored in the browser, whose WebSocket exposes no such knob — Transport races the connect there instead.
Was this page helpful?