Skip to main content

Documentation Index

Fetch the complete documentation index at: https://socket-serve.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

​
Methods

​
emit

Send event to server. 
socket.emit(event: string, data: any, ackCallback?: Function): void
Examples: 
// Simple emit
socket.emit('message', { text: 'Hello' });

// With acknowledgment
socket.emit('getData', { id: 123 }, (response, error) => {
  if (error) {
    console.error('Timeout');
  } else {
    console.log('Response:', response);
  }
});

​
on

Listen for server events. 
socket.on(event: string, handler: (data: any) => void): void
Example: 
socket.on('message', (data) => {
  console.log('Received:', data);
});

​
disconnect

Disconnect from server. 
socket.disconnect(): void

​
Properties

​
id

Session identifier (string | null) 
console.log('Session ID:', socket.id);

​
connected

Connection status (boolean) 
if (socket.connected) {
  console.log('Connected');
}