云压测
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 云压测 > JavaScript API 列表 > pts/ws > ws.connect

ws.connect

最近更新时间：2023-03-09 15:26:53

我的收藏
ws.connect 根据指定参数建立 Websocket 连接，并执行用户定义的逻辑，返回 Response 对象。
connect(url: string, callback: (socket: Socket) => void, headers?: Record<string, string>): Response

参数

参数
类型
描述
url
string
请求连接的地址。
callback
function
回调函数，在完成连接后将 ws.Socket 对象传入该回调函数，用户可以在该函数中定义 Websocket 请求逻辑。
headers（可选）
Record<string, string>
请求连接时的 headers 配置。

返回

类型
描述
Response
object，包含 ws.connect 返回的响应结果。

样例

建立连接
import ws from 'pts/ws';

export default function () {
  const res = ws.connect("ws://mockwebsocket.pts.svc.cluster.local/echo", function (socket) {
    socket.on('open', () => {
      console.log('connected');
      socket.close();
    );
  });
}
建立连接，并指定 headers 参数
import ws from 'pts/ws';

export default function () {
  const headers = {
    'X-MyApplication': 'PTS',
    'X-MyScript': 'Websocket',
  }
  const res = ws.connect("ws://mockwebsocket.pts.svc.cluster.local/echo", function (socket) {
    socket.on('open', () => {
      console.log('connected');
      socket.close();
    });
  }, headers);
}


中国站