Home > SYS_WebSocket > close

SYS_WebSocket.close() method

关闭 WebSocket 连接

签名

function close(id: string, code?: number, reason?: string, extensionUuid?: string): void;

参数名

参数	类型	描述
id	string	自定义的 WebSocket ID
code	number	（可选） 数字状态码，对应 WebSocket.CloseEvent 内允许的状态码
reason	string	（可选） 一个人类可读的字符串，解释连接关闭的原因
extensionUuid	string	（可选） 扩展 UUID，一般不需要指定，仅当需要操作其它扩展建立的 WebSocket 连接时才需要指定为其它扩展的 UUID

返回值

void

备注

注意：本接口需要使用者启用扩展的外部交互权限，如若未启用将始终 throw Error

示例

// 1. 先注册一条连接用于演示
eda.sys_WebSocket.register('嘉立创示例_关闭', 'ws://127.0.0.1:49620', () => {}, () => {
	console.log('连接已建立');
});

// 2. 等待握手完成
await new Promise(r => setTimeout(r, 1500));

// 3. 以「正常关闭」状态码 1000 关闭连接，并附带原因
eda.sys_WebSocket.close('嘉立创示例_关闭', 1000, '演示完毕');
console.log('已关闭连接（code 1000）');