Skip to main content

IWebSocketClient

Properties​

adminUser​

adminUser: AdminUser


authorize​

authorize: () => Promise<AdminUserAuthorizationResult>

Authorizes handshake request of this connection again: verifies its auth jwt and runs adminUserAuthorize hooks, so access which was revoked after connection was established is noticed.

Returns​

Promise<AdminUserAuthorizationResult>


clientId?​

optional clientId?: string


close​

close: () => void

Returns​

void


id​

id: string


lastPing​

lastPing: number


onClose​

onClose: (handler) => void

Parameters​

ParameterType
handler() => void

Returns​

void


onMessage​

onMessage: (handler) => void

Parameters​

ParameterType
handler(message) => void

Returns​

void


send​

send: (message) => void

Parameters​

ParameterType
messagestring

Returns​

void


topics​

topics: Set<string>