Patches

WebSocket Connection

WebSocket Connection

Defines and establishes a connection to a WebSocket that you can then send messages to with the WebSocket Send patch and receive messages from with the WebSocket Receive patch.

WebSocket Connection

  • Connect
  • URL
  • Headers
  • Connection
  • Connected
  • Error

Connect

A boolean to indicate whether to connect to the WebSocket.

URL

The URL the WebSocket should connect to. Should use the ws:// or wss:// schemes.

Headers

JSON with key/value pairs for any headers to set when connecting to the WebSocket.

Connection

Value representing the connection that should be connected to WebSocket Send and WebSocket Receive patches.

Connected

Whether there is an active connection.

Error

Text describing any latest error with the connection, sending, or receiving. Empty if no error.