Options
All
  • Public
  • Public/Protected
  • All
Menu

Class WebSocketClient<User, Value, Credential>

Type parameters

Hierarchy

  • ClientEmitter<WebSocketClientContext<User, Value>>
    • WebSocketClient

Index

Constructors

Accessors

Methods

Constructors

constructor

  • new WebSocketClient<User, Value, Credential>(__namedParameters?: ClientOptions<User, Credential>): WebSocketClient<User, Value, Credential>

Accessors

channel

  • get channel(): null | WebSocketConnection

isClosed

  • get isClosed(): boolean

isConnected

  • get isConnected(): boolean

user

  • get user(): null | User

Methods

Protected _emitError

  • _emitError(err: Error): void

Protected _emitEvent

  • _emitEvent(ctx: WebSocketClientContext<User, Value>): void

close

  • close(code?: number, reason?: string): void

onError

  • onError(listener: (err: Error) => void): void

onEvent

  • onEvent(listener: (ctx: WebSocketClientContext<User, Value>) => void): void

removeErrorListener

  • removeErrorListener(listener: (err: Error) => void): boolean

removeEventListener

  • removeEventListener(listener: (ctx: WebSocketClientContext<User, Value>) => void): boolean

send

Generated using TypeDoc