Skip to main content
Version: 57.2.0

RevalidatableSocket

Minimal socket shape the sweep needs. Lets tests drive it with a mock.

Extends​

Properties​

data?​

optional data?: SocketDataBag

Overrides​

SocketWithDecodedToken.data

decodedToken?​

optional decodedToken?: DecodedRealtimeToken

Inherited from​

SocketWithDecodedToken.decodedToken

disconnect​

disconnect: (close?) => void

Parameters​

close?​

boolean

Returns​

void

emit​

emit: (event, payload?) => void

Parameters​

event​

string

payload?​

unknown

Returns​

void

encodedToken?​

optional encodedToken?: string

id​

id: string

join​

join: (room) => void | Promise<void>

Parameters​

room​

string

Returns​

void | Promise<void>

leave​

leave: (room) => void | Promise<void>

Parameters​

room​

string

Returns​

void | Promise<void>