小程序开放平台

文档中心
基础
界面
网络
发起请求
上传
下载
Websocket
connectSocket
closeSocket
sendSocketMessage
onSocketOpen
onSocketClose
onSocketMessage
onSocketError
SocketTask
SocketTask
SocketTask.send
SocketTask.close
SocketTask.onOpen
SocketTask.onMessage
SocketTask.onClose
SocketTask.onError
数据缓存
媒体
位置
开放接口
设备
XHSML
性能
文件
数据分析
画布

xhs.SocketTask-close

开发
>
JS API
>
网络
>
Websocket
>
SocketTask
>
SocketTask.close
>
更新时间:2025-04-10 15:55:48

以 Promise 风格 调用:不支持

关闭 WebSocket 连接

参数

Object object

属性
类型
默认值
必填
说明
codenumber1000(表示正常关闭连接)一个数字值表示关闭连接的状态号,表示连接被关闭的原因。
reasonstring一个可读的字符串,表示连接被关闭的原因。这个字符串必须是不长于 123 字节的 UTF-8 文本(不是字符)。
successfunction接口调用成功的回调函数
failfunction接口调用失败的回调函数
completefunction接口调用结束的回调函数(调用成功、失败都会执行)

实例代码

// 创建 WebSocket 连接
const socketTask = xhs.connectSocket({
  url: 'wss://example.com/socket'
});

// 关闭 WebSocket 连接
socketTask.close({
  code: 1000, // 可选,关闭状态码,默认值为 1000(正常关闭)
  reason: '正常关闭连接', // 可选,关闭原因
  success: (res) => {
    console.log('WebSocket 关闭成功:', res.errMsg);
  },
  fail: (err) => {
    console.error('WebSocket 关闭失败:', err.errMsg);
  },
  complete: () => {
    console.log('SocketTask.close 调用结束');
  }
});
该文档是否对您有帮助?