Skip to main content
Create a WebSocket connection to a server.

​
Parameters

PropertyTypeRequiredDescription
urlStringYesWebSocket URL (wss:// required in production)
headerObjectNoRequest headers
successFunctionNoCallback on success
failFunctionNoCallback on failure
completeFunctionNoCallback that always executes

​
Code Example

my.connectSocket({
  url: 'wss://example.com/socket',
  success: () => {
    console.log('Connection initiated');
  }
});

my.onSocketOpen(() => {
  console.log('WebSocket connected');
  my.sendSocketMessage({ data: 'Hello' });
});

my.onSocketMessage((res) => {
  console.log('Received:', res.data);
});

my.sendSocketMessage

Send message

my.closeSocket

Close connection