WebSocket · Yuari Executor Docs

WebSocket.connect(url) / WebSocket.open(url) / WebSocket.Connect(url) / WebSocket.Open(url) / WebSocket.New(url) / WebSocket.new(url)

Opens a WebSocket and returns a socket object with modern lowercase aliases and legacy names.

local ws = WebSocket.connect("wss://echo.websocket.events")
ws.OnMessage:Connect(function(message)
    print(message)
end)
ws:Send("hello")

websocket_connect(url) / websocket_send(id, message, binary?) / websocket_poll(id) / websocket_close(id)

Legacy low-level WebSocket helpers that operate on a connection id.

local id = websocket_connect("wss://echo.websocket.events")
websocket_send(id, "hello")
for _, message in ipairs(websocket_poll(id)) do
    print(message)
end
websocket_close(id)

socket:Send(message) / socket:send(message)

Sends a message through the socket.

local ws = WebSocket.open("wss://echo.websocket.events")
ws:Send("hello")

socket:Close() / socket:close()

Closes the socket.

local ws = WebSocket.open("wss://echo.websocket.events")
ws:Close()

socket.OnMessage / socket.onMessage / socket.OnClose / socket.onClose

Signals fired for incoming messages and connection close.

local ws = WebSocket.open("wss://echo.websocket.events")
ws.OnMessage:Connect(function(message)
    print(message)
end)
ws.OnClose:Connect(function()
    print("closed")
end)

socket.IsClosed / socket.isClosed

True once the socket has closed.

local ws = WebSocket.open("wss://echo.websocket.events")
print(ws.IsClosed)