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.

​
Usage

import { connect } from 'socket-serve/client';

const socket = connect(url, options);

​
Parameters

​
url

Server endpoint URL (string, required) 
// Absolute URL
const socket = connect('https://api.example.com/socket');

// Relative URL
const socket = connect('/api/socket');

​
options

Configuration object (optional) 
interface ConnectOptions {
  transport?: 'sse' | 'polling';
}
transport: Transport mechanism
  • 'sse' - Server-Sent Events (default)
  • 'polling' - HTTP polling

​
Examples

​
Default (SSE)

const socket = connect('/api/socket');

​
Force Polling

const socket = connect('/api/socket', {
  transport: 'polling'
});

​
Returns

ClientSocket instance