tencent cloud

Socket.on
Download PDF
Last updated: 2025-03-11 20:32:31
Socket.on
Last updated: 2025-03-11 20:32:31
Download PDF
Socket.on is used for message event listening. 
on(event: string, callback: ((...args: any[]) => void)): void

Parameters

Parameter
Type
Description
event
string
Event name. The list of supported events is as follows:
open, establish the connection;
close, close the connection;
message, receive text messages;
binaryMessage, receive binary messages;
pong, receive pong messages;
ping, receive ping messages;
callback
function
Callback function.

Return

Type
Description
void
No content returned.

Samples

import ws from 'pts/ws';
import { check, sleep } from 'pts';

export default function () {
  const res = ws.connect('ws://localhost:8080/echo', function (socket) {
    // Message event listening.
    socket.on('open', () => console.log('connected'));
    socket.on('message', (data) => console.log('Message received: ', data));
    socket.on('close', () => console.log('disconnected'));
    socket.send('message');
    socket.setTimeout(function () {
      console.log('3 seconds passed, closing the socket');
      socket.close();
    }, 3000);
    socket.setInterval(function () {
      socket.ping();
    }, 500);
    socket.setLoop(function () {
      sleep(0.1);
      socket.send('loop message');
    });
  });
  check('status is 101', () => res.status === 101);
}

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback