Skip to main content

Interface: SocketIOWebSocketPluginOptions

An interface extending the base WebSocketPluginOptions to include additional configuration options specific to the Socket.IO WebSocket plugin.

Extends​

Properties​

adapter​

adapter: WebSocketAdapterClass

The WebSocket adapter to use. Express or Fastify are supported.

Inherited from​

WebSocketPluginOptions.adapter

connectTimeout?​

optional connectTimeout?: number

The number of ms before disconnecting a client that has not successfully joined a namespace.

Inherited from​

WebSocketPluginOptions.connectTimeout

path?​

optional path?: string

It is the name of the path that is captured on the server side.

Inherited from​

WebSocketPluginOptions.path

plugin​

plugin: PluginType

Inherited from​

WebSocketPluginOptions.plugin

port?​

optional port?: number

The port on which the WebSocket server will listen. Default is 3000.

Inherited from​

WebSocketPluginOptions.port

serveClient?​

optional serveClient?: boolean

Whether to serve the client files. Default is true. If set to false, the client files will not be served.

Inherited from​

WebSocketPluginOptions.serveClient

useHttpPluginServer​

useHttpPluginServer: boolean

Whether to use the built-in HTTP server for WebSockets. Default is false. If set to true, the WebSocket server will be created using the built-in HTTP server.

Inherited from​

WebSocketPluginOptions.useHttpPluginServer