Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Open a WebSocket connection.
WebSocket.connect(url: string) -> WebSocket
ws:// or wss:// url and returns the connection object. The call yields until the handshake finishes. The returned object carries Send, Close, the OnMessage and OnClose signals, and an IsClosed flag.
Also registered as connect.
ws:// or wss:// url.local ws = WebSocket.connect("wss://echo.websocket.events")
ws.OnMessage:Connect(function(msg) print("got", msg) end)
ws:Send("hello")
| Message | Condition |
|---|---|
the websocket url must be a string | Argument 1 was not a string. |
the websocket url must start with ws:// or wss:// and contain a host | The url was not a valid WebSocket url. |
this host is not permitted for websockets | The host is on the block list. |
the websocket could not be set up | The connection could not be established. |