Skip to main content

WebSocket选项对象

🌐 WebSocketOptions Object

  • protocols string | string[](optional)- 请求的 WebSocket 子协议。
  • headers Record<string, string>(optional)- 在开启握手时要发送的额外 HTTP 头。
  • origin string(optional)- 在进行握手时要发送的 Origin 头的值。默认是 WebSocket URL 的源对应的 http(s)(例如,连接到 wss://api.example.com 会发送 Origin: https://api.example.com),这样服务器和 SameSite Cookie 规则就会把连接当作同源处理。
  • useSessionCookies boolean(optional)- 是否在开启握手时从会话发送 cookie,并存储在握手响应中收到的 cookie。默认值是 false。
  • session Session(optional)- Session 与该连接相关联。
  • partition string(optional)- [partition](../session.md) 的名称,该连接所关联的对象。默认值为空字符串,表示默认会话。如果提供了 session,则会忽略 partition。