WebSocketObject.Close - Byte Documentation

socket:Close(): ()

Aliases

WebSocketObject.close

Arguments

This function takes no arguments.

Returns

This function returns no values. Start a local WebSocket server first. Close is idempotent. OnClose usually receives nil for a local close. Backing events are destroyed two Heartbeat frames later. 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
socket.OnClose:Connect(function(reason) print("Closed", reason) end)
socket:Close()