WebSocketClient | @egodigital/egoose

A web socket client.

Hierarchy

EventEmitter
- WebSocketClient

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebSocketClient(host: WebSocketHost, socket: ws): WebSocketClient

- Defined in src/http/websockets.ts:268
Initializes a new instance of that class.

Parameters
- host: WebSocketHost
  
  The underlying host.
- socket: ws
  
  The underlying socket.
Returns WebSocketClient

Properties

Readonly host

host: WebSocketHost

The underlying host.

Readonly socket

socket: ws

The underlying socket.

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

addListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from WebSocketHost.addListener

Overrides LogsDocument.addListener
- Defined in node_modules/@types/node/events.d.ts:20
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from WebSocketHost.emit

Overrides LogsDocument.emit
- Defined in node_modules/@types/node/events.d.ts:32
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from WebSocketHost.eventNames

Overrides LogsDocument.eventNames
- Defined in node_modules/@types/node/events.d.ts:33
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from WebSocketHost.getMaxListeners

Overrides LogsDocument.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:29
Returns number

init

init(): void

- Defined in src/http/websockets.ts:285
Initializes the instance.

Returns void

listenerCount

listenerCount(type: string | symbol): number

Inherited from WebSocketHost.listenerCount

Overrides LogsDocument.listenerCount
- Defined in node_modules/@types/node/events.d.ts:34
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from WebSocketHost.listeners

Overrides LogsDocument.listeners
- Defined in node_modules/@types/node/events.d.ts:30
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from WebSocketHost.off

Overrides LogsDocument.off
- Defined in node_modules/@types/node/events.d.ts:26
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from WebSocketHost.on

Overrides LogsDocument.on
- Defined in node_modules/@types/node/events.d.ts:21
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

onType

onType<TData>(pattern: RegExp, listener: WebSocketOnTypeEventListener<TData>): Function
onType<TData>(type: string, listener: WebSocketOnTypeEventListener<TData>): Function
onType<TData>(predicate: Predicate<string>, listener: WebSocketOnTypeEventListener<TData>): Function

- Defined in src/http/websockets.ts:320
Registers an event listener for a message type.

Type parameters
- TData
Parameters
- pattern: RegExp
  
  The Regex pattern, that checks the type.
- listener: WebSocketOnTypeEventListener<TData>
  
  The listener.
Returns Function

The "real" event listener.
- Defined in src/http/websockets.ts:332
Registers an event listener for a message type.

Type parameters
- TData
Parameters
- type: string
  
  The type.
- listener: WebSocketOnTypeEventListener<TData>
  
  The listener.
Returns Function

The "real" event listener.
- Defined in src/http/websockets.ts:344
Registers an event listener for a message type.

Type parameters
- TData
Parameters
- predicate: Predicate<string>
  
  The predicate, that checks the type.
- listener: WebSocketOnTypeEventListener<TData>
  
  The listener.
Returns Function

The "real" event listener.

once

once(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from WebSocketHost.once

Overrides LogsDocument.once
- Defined in node_modules/@types/node/events.d.ts:22
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from WebSocketHost.prependListener

Overrides LogsDocument.prependListener
- Defined in node_modules/@types/node/events.d.ts:23
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from WebSocketHost.prependOnceListener

Overrides LogsDocument.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:24
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from WebSocketHost.rawListeners

Overrides LogsDocument.rawListeners
- Defined in node_modules/@types/node/events.d.ts:31
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from WebSocketHost.removeAllListeners

Overrides LogsDocument.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:27
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: (...args: any[]) => void): this

Inherited from WebSocketHost.removeListener

Overrides LogsDocument.removeListener
- Defined in node_modules/@types/node/events.d.ts:25
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

send

send(type: string, data?: any): Promise<void>

- Defined in src/http/websockets.ts:380
Sends a message to the remote client.

Parameters
- type: string
  
  The type.
- Optional data: any
Returns Promise<void>

setMaxListeners

setMaxListeners(n: number): this

Inherited from WebSocketHost.setMaxListeners

Overrides LogsDocument.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:28
Parameters
- n: number
Returns this

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from WebSocketHost.listenerCount
- Defined in node_modules/@types/node/events.d.ts:17
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

host: WebSocketHost

socket: ws

Returns WebSocketClient

Properties

Readonly host

Readonly socket

Static defaultMaxListeners

Methods

addListener

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns this

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

getMaxListeners

Returns number

init

Returns void

listenerCount

Parameters

type: string | symbol

Returns number

listeners

Parameters

event: string | symbol

Returns Function[]

off

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns this

on

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns this

onType

Type parameters

TData

Parameters

pattern: RegExp

listener: WebSocketOnTypeEventListener<TData>

Returns Function

Type parameters

TData

Parameters

type: string

listener: WebSocketOnTypeEventListener<TData>

Returns Function

Type parameters

TData

Parameters

predicate: Predicate<string>

listener: WebSocketOnTypeEventListener<TData>

Returns Function

once

Parameters