Class SimpleWebSocket

A simple web socket instance.

Hierarchy

EventEmitter
- SimpleWebSocket

Index

Constructors

constructor

Properties

Constructors

constructor

new SimpleWebSocket(options: SimpleWebSocketOptions): SimpleWebSocket

- Defined in src/client/SimpleWebSocket.ts:68
Initializes a new instance of that class.

Parameters
- options: SimpleWebSocketOptions
  
  The options.
Returns SimpleWebSocket

Properties

Private _onMessageHandlers

_onMessageHandlers: OnMessageHandlerItem[] | undefined

options

options: SimpleWebSocketOptions

The options.

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addListener

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

Inherited from SimpleWebSocket.addListener

Overrides EventEmitter.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

close

close(): Promise<unknown>

- Defined in src/client/SimpleWebSocket.ts:86
Closes the connection.

Returns Promise<unknown>

connect

connect(key?: Nilable<WebSocketServerKey>): Promise<void>

- Defined in src/client/SimpleWebSocket.ts:101
Starts the connection.

Parameters
- Optional key: Nilable<WebSocketServerKey>
Returns Promise<void>

emit

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

Inherited from SimpleWebSocket.emit

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

error

error<TRef>(err: any, ref?: Nilable<TRef>): Promise<void>

- Defined in src/client/SimpleWebSocket.ts:150
Sends an error message.

Type parameters
- TRef: any
Parameters
- err: any
  
  The error information.
- Optional ref: Nilable<TRef>
Returns Promise<void>

eventNames

eventNames(): Array<string | symbol>

Inherited from SimpleWebSocket.eventNames

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

getMaxListeners

getMaxListeners(): number

Inherited from SimpleWebSocket.getMaxListeners

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

init

init(): void

- Defined in src/client/SimpleWebSocket.ts:179
Initializes that instance.

Returns void

listenerCount

listenerCount(type: string | symbol): number

Inherited from SimpleWebSocket.listenerCount

Overrides EventEmitter.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 SimpleWebSocket.listeners

Overrides EventEmitter.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 SimpleWebSocket.off

Overrides EventEmitter.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

ok

ok<TData, TRef>(data?: Nilable<TData>, ref?: Nilable<TRef>): Promise<void>

- Defined in src/client/SimpleWebSocket.ts:262
Sends an OK message.

Type parameters
- TData: any
- TRef: any
Parameters
- Optional data: Nilable<TData>
- Optional ref: Nilable<TRef>
Returns Promise<void>

on

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

Inherited from SimpleWebSocket.on

Overrides EventEmitter.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

onMessage

onMessage<TData>(handler: SimpleWebSocketMessageHandler<TData>, filter?: Nilable<Predicate<WebSocketMessage<TData>>>): Disposable

- Defined in src/client/SimpleWebSocket.ts:274
Registers a message handler.

Type parameters
- TData: any
Parameters
- handler: SimpleWebSocketMessageHandler<TData>
  
  The handler to register.
- Optional filter: Nilable<Predicate<WebSocketMessage<TData>>>
Returns Disposable

A context onbject, which can be used to unregister the handler.

once

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

Inherited from SimpleWebSocket.once

Overrides EventEmitter.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 SimpleWebSocket.prependListener

Overrides EventEmitter.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 SimpleWebSocket.prependOnceListener

Overrides EventEmitter.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 SimpleWebSocket.rawListeners

Overrides EventEmitter.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 SimpleWebSocket.removeAllListeners

Overrides EventEmitter.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 SimpleWebSocket.removeListener

Overrides EventEmitter.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<TData, TRef>(type: string, data?: Nilable<TData>, ref?: Nilable<TRef>): Promise<void>

- Defined in src/client/SimpleWebSocket.ts:305
Sends data to the remote server.

Type parameters
- TData: any
- TRef: any
Parameters
- type: string
  
  The type of the data.
- Optional data: Nilable<TData>
- Optional ref: Nilable<TRef>
Returns Promise<void>

setMaxListeners

setMaxListeners(n: number): this

Inherited from SimpleWebSocket.setMaxListeners

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

Static connectTo

connectTo(url: Url, key?: Nilable<WebSocketServerKey>): Promise<SimpleWebSocket>

- Defined in src/client/SimpleWebSocket.ts:135
Creates and opens a new connection to a remote web socket host.

Parameters
- url: Url
- Optional key: Nilable<WebSocketServerKey>
Returns Promise<SimpleWebSocket>

The promise with the successful connected socket.

Static fromUrl

fromUrl(url: Url): SimpleWebSocket

- Defined in src/client/SimpleWebSocket.ts:170
Creates a new instance from an URL.

Parameters
- url: Url
  
  The URL.
Returns SimpleWebSocket

Static listenerCount

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

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

since v4.0.0

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

Generated using TypeDoc