Interface ServerOptions

lib/index.ts:65–115

  | Http2Server;

interface ServerOptions extends EngineOptions, AttachOptions {
  /**
   * name of the path to capture
   * @default "/socket.io"
   */
  path: string;
  /**
   * whether to serve the client files
   * @default true
   */
  serveClient: boolean;
  /**
   * the adapter to use
   * @default the in-memory adapter (https://github.com/socketio/socket.io-adapter)
   */
  adapter: AdapterConstructor;
  /**
   * the parser to use
   * @default the default parser (https://github.com/socketio/socket.io-parser)
   */
  parser: any;
  /**
   * how many ms before a client without namespace is closed
   * @default 45000
   */
  connectTimeout: number;
  /**
   * Whether to enable the recovery of connection state when a client temporarily disconnects.
   *
   * The connection state includes the missed packets, the rooms the socket was in and the `data` attribute.
   */
  connectionStateRecovery: {
    /**
     * The backup duration of the sessions and the packets.
     *
     * @default 120000 (2 minutes)
     */
    maxDisconnectionDuration?: number;
    /**
     * Whether to skip middlewares upon successful connection state recovery.
     *
     * @default true
     */
    skipMiddlewares?: boolean;
  };
  /**
   * Whether to remove child namespaces that have no sockets connected to them
   * @default false
   */
  cleanupEmptyChildNamespaces: boolean;
}

/**
 * Represents a Socket.IO server.