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.

​
Constructor

import { createSocketServer } from 'socket-serve';

const server = createSocketServer({
  redisUrl: process.env.REDIS_URL!
});

​
Events

​
connection

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

​
Configuration

​
Basic

const server = createSocketServer({
  redisUrl: 'redis://localhost:6379'
});

​
With Options

const server = createSocketServer({
  redisUrl: process.env.REDIS_URL!,
  redisOptions: {
    password: 'secret',
    db: 0,
    maxRetriesPerRequest: 3
  }
});

​
Custom Redis Instance

import Redis from 'ioredis';

const redis = new Redis(process.env.REDIS_URL!);

const server = createSocketServer({
  redis
});