Interface: IServerConfig

Table of contents

Properties

• allowRequest
• cors
• httpServer
• maxDecompressedMessageSize
• maxHttpBufferSize
• path
• port
• socketIoAdapter

Properties

allowRequest

• Optional allowRequest: any

Forwarded directly to the Socket.IO allowRequest option. Use this to control whether a handshake or upgrade request should be accepted.

see https://socket.io/docs/v4/server-options/#allowrequest

cors

• Optional cors: any

Forwarded directly to the Socket.IO cors option. Use this to configure CORS behavior for Socket.IO HTTP requests.

see https://socket.io/docs/v4/handling-cors/

httpServer

• Optional httpServer: Server | Server | Http2SecureServer | Http2Server

maxDecompressedMessageSize

• Optional maxDecompressedMessageSize: number

The maximum allowed size in bytes after a compressed message is decompressed. Exceeding this limit reports a message error without crashing the server process. Defaults to the current Node.js maximum string length, or 512 MiB when the runtime does not expose that limit.

maxHttpBufferSize

• Optional maxHttpBufferSize: number

The maximum incoming message size in bytes. Socket.IO will close the connection when a payload exceeds this value. Defaults to 512 MiB.

path

• Optional path: string

The request path for the server. Defaults to '/collaboration/'.

port

• Optional port: number

socketIoAdapter

• Optional socketIoAdapter: any

Custom Socket.IO adapter for multi-node/distributed deployments. Allows integration with various message brokers (Redis, MongoDB, PostgreSQL, etc.) to enable message broadcasting across multiple server instances.

see https://socket.io/docs/v4/adapter/