ConnectResponse interface

Response of the connect event.

Properties

groups

Set the groups the connection would like to join.

roles

Set the roles the connection belongs to.

subprotocol

Set the subprotocol for the connection to complete WebSocket handshake.

userId

Set the userId for the connection.

Property Details

groups

Set the groups the connection would like to join.

groups?: string[]

Property Value

string[]

roles

Set the roles the connection belongs to.

roles?: string[]

Property Value

string[]

subprotocol

Set the subprotocol for the connection to complete WebSocket handshake.

subprotocol?: string

Property Value

string

userId

Set the userId for the connection.

userId?: string

Property Value

string