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.

​
createSocketServer

Creates a new socket server instance. 
import { createSocketServer } from 'socket-serve';

const server = createSocketServer(options);

​
Parameters

  • options.redisUrl (string, required) - Redis connection URL
  • options.redisOptions (object, optional) - ioredis configuration options
  • options.redis (Redis, optional) - Pre-configured Redis instance

​
Returns

SocketServer instance

​
SocketServer

​
Events

​
connection

Emitted when a client connects. 
server.on('connection', (socket: ServerSocket) => {
  console.log('Client connected:', socket.id);
});

​
Next Steps