WebSocket.connect - Byte Documentation

WebSocket.connect(url: string): WebSocketObject

Aliases

WebSocket.Connect
WebSocket.new
WebSocket.New
websocket.connect
websocket.Connect
websocket.new
websocket.New

Arguments

string

required

A ws:// or wss:// endpoint. The server must accept a WebSocket handshake.

Returns

WebSocketObject

The connected socket facade with Send, Close, OnMessage, and OnClose.

Run a local WebSocket server on port 8765 first. Public connect raises on invalid URL/connection/facade failure; use pcall. Hold a strong socket reference. Open waits for the native connection; received messages are pumped on Heartbeat. Related types: WebSocket types & behavior.

Example

local ok, socket = pcall(WebSocket.connect, "ws://127.0.0.1:8765")
if not ok then warn(socket); return end
local messages = socket.OnMessage:Connect(function(data, binary) print(data, binary) end)
local closing = socket.OnClose:Connect(function(reason) print("Closed", reason) end)
local sent, err = socket:Send("hello")
if not sent then warn(err) end
task.delay(5, function()
    socket:Close()
    task.delay(0.2, function() messages:Disconnect(); closing:Disconnect() end)
end)

​Aliases

​Arguments

​Returns

​Example

Aliases

Arguments

Returns

Example