Synclets logoSynclets

WsBrokerTransportOptions

The WsBrokerTransportOptions type describes additional configuration for a WsBrokerTransport.

(
  {
    webSocketServer: WebSocketServer;
    path?: string | null;
    brokerPaths?: RegExp;
  } &
  TransportOptions
)
TypeDescription
webSocketServerWebSocketServer

The webSocketServer property specifies the WebSocketServer instance to wrap.

path?string | null

The path property specifies the WebSocket path to listen on such that the synclet can itself participate in the brokered communication. Leave as the default (null) for broker-only mode where the synclet only routes messages between clients without participating itself.

brokerPaths?RegExp

The brokerPaths property specifies a regex pattern for broker path matching.

Since

v0.0.0