WebSocket | Electron Forge

Hierarchy

EventEmitter
- WebSocket

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new WebSocket(address: string | URL, options?: ClientRequestArgs | WebSocket.ClientOptions): WebSocket
new WebSocket(address: string | URL, protocols?: string | string[], options?: ClientRequestArgs | WebSocket.ClientOptions): WebSocket

Overrides EventEmitter.constructor
- Defined in node_modules/@types/ws/index.d.ts:66
Parameters
- address: string | URL
- Optional options: ClientRequestArgs | WebSocket.ClientOptions
Returns WebSocket
Overrides EventEmitter.constructor
- Defined in node_modules/@types/ws/index.d.ts:67
Parameters
- address: string | URL
- Optional protocols: string | string[]
- Optional options: ClientRequestArgs | WebSocket.ClientOptions
Returns WebSocket

Properties

Readonly CLOSED

CLOSED: 3

The connection is closed.

Readonly CLOSING

CLOSING: 2

The connection is in the process of closing.

Readonly CONNECTING

CONNECTING: 0

The connection is not yet open.

Readonly OPEN

OPEN: 1

The connection is open and ready to communicate.

binaryType

binaryType: "nodebuffer" | "arraybuffer" | "fragments"

Readonly bufferedAmount

bufferedAmount: number

Readonly extensions

extensions: string

onclose

onclose: (event: WebSocket.CloseEvent) => void

Type declaration

- (event: WebSocket.CloseEvent): void
- Parameters
  - event: WebSocket.CloseEvent
  Returns void

onerror

onerror: (event: WebSocket.ErrorEvent) => void

Type declaration

- (event: WebSocket.ErrorEvent): void
- Parameters
  - event: WebSocket.ErrorEvent
  Returns void

onmessage

onmessage: (event: WebSocket.MessageEvent) => void

Type declaration

- (event: WebSocket.MessageEvent): void
- Parameters
  - event: WebSocket.MessageEvent
  Returns void

onopen

onopen: (event: WebSocket.Event) => void

Type declaration

- (event: WebSocket.Event): void
- Parameters
  - event: WebSocket.Event
  Returns void

Readonly protocol

protocol: string

Readonly readyState

readyState: 0 | 1 | 2 | 3

The current state of the connection

Readonly url

url: string

Static Readonly CLOSED

CLOSED: 3

The connection is closed.

Static Readonly CLOSING

CLOSING: 2

The connection is in the process of closing.

Static Readonly CONNECTING

CONNECTING: 0

The connection is not yet open.

Static Readonly OPEN

OPEN: 1

The connection is open and ready to communicate.

Methods

addEventListener

addEventListener(method: "message", cb: (event: WebSocket.MessageEvent) => void, options?: WebSocket.EventListenerOptions): void
addEventListener(method: "close", cb: (event: WebSocket.CloseEvent) => void, options?: WebSocket.EventListenerOptions): void
addEventListener(method: "error", cb: (event: WebSocket.ErrorEvent) => void, options?: WebSocket.EventListenerOptions): void
addEventListener(method: "open", cb: (event: WebSocket.Event) => void, options?: WebSocket.EventListenerOptions): void

- Defined in node_modules/@types/ws/index.d.ts:85
Parameters
- method: "message"
- cb: (event: WebSocket.MessageEvent) => void
  - - (event: WebSocket.MessageEvent): void
    - Parameters
      - event: WebSocket.MessageEvent
      Returns void
- Optional options: WebSocket.EventListenerOptions
Returns void
- Defined in node_modules/@types/ws/index.d.ts:90
Parameters
- method: "close"
- cb: (event: WebSocket.CloseEvent) => void
  - - (event: WebSocket.CloseEvent): void
    - Parameters
      - event: WebSocket.CloseEvent
      Returns void
- Optional options: WebSocket.EventListenerOptions
Returns void
- Defined in node_modules/@types/ws/index.d.ts:95
Parameters
- method: "error"
- cb: (event: WebSocket.ErrorEvent) => void
  - - (event: WebSocket.ErrorEvent): void
    - Parameters
      - event: WebSocket.ErrorEvent
      Returns void
- Optional options: WebSocket.EventListenerOptions
Returns void
- Defined in node_modules/@types/ws/index.d.ts:100
Parameters
- method: "open"
- cb: (event: WebSocket.Event) => void
  - - (event: WebSocket.Event): void
    - Parameters
      - event: WebSocket.Event
      Returns void
- Optional options: WebSocket.EventListenerOptions
Returns void

addListener

addListener(event: "close", listener: (code: number, reason: Buffer) => void): WebSocket
addListener(event: "error", listener: (err: Error) => void): WebSocket
addListener(event: "upgrade", listener: (request: IncomingMessage) => void): WebSocket
addListener(event: "message", listener: (data: WebSocket.RawData, isBinary: boolean) => void): WebSocket
addListener(event: "open", listener: () => void): WebSocket
addListener(event: "ping" | "pong", listener: (data: Buffer) => void): WebSocket
addListener(event: "unexpected-response", listener: (request: ClientRequest, response: IncomingMessage) => void): WebSocket
addListener(event: string | symbol, listener: (...args: any[]) => void): WebSocket

Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:148
Parameters
- event: "close"
- listener: (code: number, reason: Buffer) => void
  - - (code: number, reason: Buffer): void
    - Parameters
      - code: number
      - reason: Buffer
      Returns void
Returns WebSocket
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:149
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns WebSocket
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:150
Parameters
- event: "upgrade"
- listener: (request: IncomingMessage) => void
  - - (request: IncomingMessage): void
    - Parameters
      - request: IncomingMessage
      Returns void
Returns WebSocket
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:151
Parameters
- event: "message"
- listener: (data: WebSocket.RawData, isBinary: boolean) => void
  - - (data: WebSocket.RawData, isBinary: boolean): void
    - Parameters
      - data: WebSocket.RawData
      - isBinary: boolean
      Returns void
Returns WebSocket
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:152
Parameters
- event: "open"
- listener: () => void
  - - (): void
    - Returns void
Returns WebSocket
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:153
Parameters
- event: "ping" | "pong"
- listener: (data: Buffer) => void
  - - (data: Buffer): void
    - Parameters
      - data: Buffer
      Returns void
Returns WebSocket
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:154
Parameters
- event: "unexpected-response"
- listener: (request: ClientRequest, response: IncomingMessage) => void
  - - (request: ClientRequest, response: IncomingMessage): void
    - Parameters
      - request: ClientRequest
      - response: IncomingMessage
      Returns void
Returns WebSocket
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:158
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns WebSocket

close

close(code?: number, data?: string | Buffer): void

- Defined in node_modules/@types/ws/index.d.ts:73
Parameters
- Optional code: number
- Optional data: string | Buffer
Returns void

off

off(event: "close", listener: (this: WebSocket, code: number, reason: Buffer) => void): WebSocket
off(event: "error", listener: (this: WebSocket, err: Error) => void): WebSocket
off(event: "upgrade", listener: (this: WebSocket, request: IncomingMessage) => void): WebSocket
off(event: "message", listener: (this: WebSocket, data: WebSocket.RawData, isBinary: boolean) => void): WebSocket
off(event: "open", listener: (this: WebSocket) => void): WebSocket
off(event: "ping" | "pong", listener: (this: WebSocket, data: Buffer) => void): WebSocket
off(event: "unexpected-response", listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void): WebSocket
off(event: string | symbol, listener: (this: WebSocket, ...args: any[]) => void): WebSocket

Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:136
Parameters
- event: "close"
- listener: (this: WebSocket, code: number, reason: Buffer) => void
  - - (this: WebSocket, code: number, reason: Buffer): void
    - Parameters
      - this: WebSocket
      - code: number
      - reason: Buffer
      Returns void
Returns WebSocket
Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:137
Parameters
- event: "error"
- listener: (this: WebSocket, err: Error) => void
  - - (this: WebSocket, err: Error): void
    - Parameters
      - this: WebSocket
      - err: Error
      Returns void
Returns WebSocket
Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:138
Parameters
- event: "upgrade"
- listener: (this: WebSocket, request: IncomingMessage) => void
  - - (this: WebSocket, request: IncomingMessage): void
    - Parameters
      - this: WebSocket
      - request: IncomingMessage
      Returns void
Returns WebSocket
Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:139
Parameters
- event: "message"
- listener: (this: WebSocket, data: WebSocket.RawData, isBinary: boolean) => void
  - - (this: WebSocket, data: WebSocket.RawData, isBinary: boolean): void
    - Parameters
      - this: WebSocket
      - data: WebSocket.RawData
      - isBinary: boolean
      Returns void
Returns WebSocket
Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:140
Parameters
- event: "open"
- listener: (this: WebSocket) => void
  - - (this: WebSocket): void
    - Parameters
      - this: WebSocket
      Returns void
Returns WebSocket
Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:141
Parameters
- event: "ping" | "pong"
- listener: (this: WebSocket, data: Buffer) => void
  - - (this: WebSocket, data: Buffer): void
    - Parameters
      - this: WebSocket
      - data: Buffer
      Returns void
Returns WebSocket
Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:142
Parameters
- event: "unexpected-response"
- listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void
  - - (this: WebSocket, request: ClientRequest, response: IncomingMessage): void
    - Parameters
      - this: WebSocket
      - request: ClientRequest
      - response: IncomingMessage
      Returns void
Returns WebSocket
Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:146
Parameters
- event: string | symbol
- listener: (this: WebSocket, ...args: any[]) => void
  - - (this: WebSocket, ...args: any[]): void
    - Parameters
      - this: WebSocket
      - Rest ...args: any[]
      Returns void
Returns WebSocket

on

on(event: "close", listener: (this: WebSocket, code: number, reason: Buffer) => void): WebSocket
on(event: "error", listener: (this: WebSocket, err: Error) => void): WebSocket
on(event: "upgrade", listener: (this: WebSocket, request: IncomingMessage) => void): WebSocket
on(event: "message", listener: (this: WebSocket, data: WebSocket.RawData, isBinary: boolean) => void): WebSocket
on(event: "open", listener: (this: WebSocket) => void): WebSocket
on(event: "ping" | "pong", listener: (this: WebSocket, data: Buffer) => void): WebSocket
on(event: "unexpected-response", listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void): WebSocket
on(event: string | symbol, listener: (this: WebSocket, ...args: any[]) => void): WebSocket

Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:112
Parameters
- event: "close"
- listener: (this: WebSocket, code: number, reason: Buffer) => void
  - - (this: WebSocket, code: number, reason: Buffer): void
    - Parameters
      - this: WebSocket
      - code: number
      - reason: Buffer
      Returns void
Returns WebSocket
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:113
Parameters
- event: "error"
- listener: (this: WebSocket, err: Error) => void
  - - (this: WebSocket, err: Error): void
    - Parameters
      - this: WebSocket
      - err: Error
      Returns void
Returns WebSocket
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:114
Parameters
- event: "upgrade"
- listener: (this: WebSocket, request: IncomingMessage) => void
  - - (this: WebSocket, request: IncomingMessage): void
    - Parameters
      - this: WebSocket
      - request: IncomingMessage
      Returns void
Returns WebSocket
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:115
Parameters
- event: "message"
- listener: (this: WebSocket, data: WebSocket.RawData, isBinary: boolean) => void
  - - (this: WebSocket, data: WebSocket.RawData, isBinary: boolean): void
    - Parameters
      - this: WebSocket
      - data: WebSocket.RawData
      - isBinary: boolean
      Returns void
Returns WebSocket
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:116
Parameters
- event: "open"
- listener: (this: WebSocket) => void
  - - (this: WebSocket): void
    - Parameters
      - this: WebSocket
      Returns void
Returns WebSocket
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:117
Parameters
- event: "ping" | "pong"
- listener: (this: WebSocket, data: Buffer) => void
  - - (this: WebSocket, data: Buffer): void
    - Parameters
      - this: WebSocket
      - data: Buffer
      Returns void
Returns WebSocket
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:118
Parameters
- event: "unexpected-response"
- listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void
  - - (this: WebSocket, request: ClientRequest, response: IncomingMessage): void
    - Parameters
      - this: WebSocket
      - request: ClientRequest
      - response: IncomingMessage
      Returns void
Returns WebSocket
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:122
Parameters
- event: string | symbol
- listener: (this: WebSocket, ...args: any[]) => void
  - - (this: WebSocket, ...args: any[]): void
    - Parameters
      - this: WebSocket
      - Rest ...args: any[]
      Returns void
Returns WebSocket

once

once(event: "close", listener: (this: WebSocket, code: number, reason: Buffer) => void): WebSocket
once(event: "error", listener: (this: WebSocket, err: Error) => void): WebSocket
once(event: "upgrade", listener: (this: WebSocket, request: IncomingMessage) => void): WebSocket
once(event: "message", listener: (this: WebSocket, data: WebSocket.RawData, isBinary: boolean) => void): WebSocket
once(event: "open", listener: (this: WebSocket) => void): WebSocket
once(event: "ping" | "pong", listener: (this: WebSocket, data: Buffer) => void): WebSocket
once(event: "unexpected-response", listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void): WebSocket
once(event: string | symbol, listener: (this: WebSocket, ...args: any[]) => void): WebSocket

Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:124
Parameters
- event: "close"
- listener: (this: WebSocket, code: number, reason: Buffer) => void
  - - (this: WebSocket, code: number, reason: Buffer): void
    - Parameters
      - this: WebSocket
      - code: number
      - reason: Buffer
      Returns void
Returns WebSocket
Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:125
Parameters
- event: "error"
- listener: (this: WebSocket, err: Error) => void
  - - (this: WebSocket, err: Error): void
    - Parameters
      - this: WebSocket
      - err: Error
      Returns void
Returns WebSocket
Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:126
Parameters
- event: "upgrade"
- listener: (this: WebSocket, request: IncomingMessage) => void
  - - (this: WebSocket, request: IncomingMessage): void
    - Parameters
      - this: WebSocket
      - request: IncomingMessage
      Returns void
Returns WebSocket
Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:127
Parameters
- event: "message"
- listener: (this: WebSocket, data: WebSocket.RawData, isBinary: boolean) => void
  - - (this: WebSocket, data: WebSocket.RawData, isBinary: boolean): void
    - Parameters
      - this: WebSocket
      - data: WebSocket.RawData
      - isBinary: boolean
      Returns void
Returns WebSocket
Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:128
Parameters
- event: "open"
- listener: (this: WebSocket) => void
  - - (this: WebSocket): void
    - Parameters
      - this: WebSocket
      Returns void
Returns WebSocket
Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:129
Parameters
- event: "ping" | "pong"
- listener: (this: WebSocket, data: Buffer) => void
  - - (this: WebSocket, data: Buffer): void
    - Parameters
      - this: WebSocket
      - data: Buffer
      Returns void
Returns WebSocket
Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:130
Parameters
- event: "unexpected-response"
- listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void
  - - (this: WebSocket, request: ClientRequest, response: IncomingMessage): void
    - Parameters
      - this: WebSocket
      - request: ClientRequest
      - response: IncomingMessage
      Returns void
Returns WebSocket
Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:134
Parameters
- event: string | symbol
- listener: (this: WebSocket, ...args: any[]) => void
  - - (this: WebSocket, ...args: any[]): void
    - Parameters
      - this: WebSocket
      - Rest ...args: any[]
      Returns void
Returns WebSocket

ping

ping(data?: any, mask?: boolean, cb?: (err: Error) => void): void

- Defined in node_modules/@types/ws/index.d.ts:74
Parameters
- Optional data: any
- Optional mask: boolean
- Optional cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void

pong

pong(data?: any, mask?: boolean, cb?: (err: Error) => void): void

- Defined in node_modules/@types/ws/index.d.ts:75
Parameters
- Optional data: any
- Optional mask: boolean
- Optional cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void

removeEventListener

removeEventListener(method: "message", cb: (event: WebSocket.MessageEvent) => void): void
removeEventListener(method: "close", cb: (event: WebSocket.CloseEvent) => void): void
removeEventListener(method: "error", cb: (event: WebSocket.ErrorEvent) => void): void
removeEventListener(method: "open", cb: (event: WebSocket.Event) => void): void

- Defined in node_modules/@types/ws/index.d.ts:106
Parameters
- method: "message"
- cb: (event: WebSocket.MessageEvent) => void
  - - (event: WebSocket.MessageEvent): void
    - Parameters
      - event: WebSocket.MessageEvent
      Returns void
Returns void
- Defined in node_modules/@types/ws/index.d.ts:107
Parameters
- method: "close"
- cb: (event: WebSocket.CloseEvent) => void
  - - (event: WebSocket.CloseEvent): void
    - Parameters
      - event: WebSocket.CloseEvent
      Returns void
Returns void
- Defined in node_modules/@types/ws/index.d.ts:108
Parameters
- method: "error"
- cb: (event: WebSocket.ErrorEvent) => void
  - - (event: WebSocket.ErrorEvent): void
    - Parameters
      - event: WebSocket.ErrorEvent
      Returns void
Returns void
- Defined in node_modules/@types/ws/index.d.ts:109
Parameters
- method: "open"
- cb: (event: WebSocket.Event) => void
  - - (event: WebSocket.Event): void
    - Parameters
      - event: WebSocket.Event
      Returns void
Returns void

removeListener

removeListener(event: "close", listener: (code: number, reason: Buffer) => void): WebSocket
removeListener(event: "error", listener: (err: Error) => void): WebSocket
removeListener(event: "upgrade", listener: (request: IncomingMessage) => void): WebSocket
removeListener(event: "message", listener: (data: WebSocket.RawData, isBinary: boolean) => void): WebSocket
removeListener(event: "open", listener: () => void): WebSocket
removeListener(event: "ping" | "pong", listener: (data: Buffer) => void): WebSocket
removeListener(event: "unexpected-response", listener: (request: ClientRequest, response: IncomingMessage) => void): WebSocket
removeListener(event: string | symbol, listener: (...args: any[]) => void): WebSocket

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:160
Parameters
- event: "close"
- listener: (code: number, reason: Buffer) => void
  - - (code: number, reason: Buffer): void
    - Parameters
      - code: number
      - reason: Buffer
      Returns void
Returns WebSocket
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:161
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns WebSocket
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:162
Parameters
- event: "upgrade"
- listener: (request: IncomingMessage) => void
  - - (request: IncomingMessage): void
    - Parameters
      - request: IncomingMessage
      Returns void
Returns WebSocket
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:163
Parameters
- event: "message"
- listener: (data: WebSocket.RawData, isBinary: boolean) => void
  - - (data: WebSocket.RawData, isBinary: boolean): void
    - Parameters
      - data: WebSocket.RawData
      - isBinary: boolean
      Returns void
Returns WebSocket
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:164
Parameters
- event: "open"
- listener: () => void
  - - (): void
    - Returns void
Returns WebSocket
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:165
Parameters
- event: "ping" | "pong"
- listener: (data: Buffer) => void
  - - (data: Buffer): void
    - Parameters
      - data: Buffer
      Returns void
Returns WebSocket
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:166
Parameters
- event: "unexpected-response"
- listener: (request: ClientRequest, response: IncomingMessage) => void
  - - (request: ClientRequest, response: IncomingMessage): void
    - Parameters
      - request: ClientRequest
      - response: IncomingMessage
      Returns void
Returns WebSocket
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:170
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns WebSocket

send

send(data: any, cb?: (err?: Error) => void): void
send(data: any, options: { binary?: boolean; compress?: boolean; fin?: boolean; mask?: boolean }, cb?: (err?: Error) => void): void

- Defined in node_modules/@types/ws/index.d.ts:76
Parameters
- data: any
- Optional cb: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void
- Defined in node_modules/@types/ws/index.d.ts:77
Parameters
- data: any
- options: { binary?: boolean; compress?: boolean; fin?: boolean; mask?: boolean }
  - Optional binary?: boolean
  - Optional compress?: boolean
  - Optional fin?: boolean
  - Optional mask?: boolean
- Optional cb: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

terminate

terminate(): void

- Defined in node_modules/@types/ws/index.d.ts:82
Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

address: string | URL

Optional options: ClientRequestArgs | WebSocket.ClientOptions

Returns WebSocket

Parameters

address: string | URL

Optional protocols: string | string[]

Optional options: ClientRequestArgs | WebSocket.ClientOptions

Returns WebSocket

Properties

Readonly CLOSED

Readonly CLOSING

Readonly CONNECTING

Readonly OPEN

binaryType

Readonly bufferedAmount

Readonly extensions

onclose

Type declaration

Parameters

event: WebSocket.CloseEvent

Returns void

onerror

Type declaration

Parameters

event: WebSocket.ErrorEvent

Returns void

onmessage

Type declaration

Parameters

event: WebSocket.MessageEvent

Returns void

onopen

Type declaration

Parameters

event: WebSocket.Event

Returns void

Readonly protocol

Readonly readyState

Readonly url

Static Readonly CLOSED

Static Readonly CLOSING

Static Readonly CONNECTING

Static Readonly OPEN

Methods

addEventListener

Parameters

method: "message"

cb: (event: WebSocket.MessageEvent) => void

Parameters

event: WebSocket.MessageEvent

Returns void

Optional options: WebSocket.EventListenerOptions

Returns void

Parameters

method: "close"

cb: (event: WebSocket.CloseEvent) => void

Parameters

event: WebSocket.CloseEvent

Returns void

Optional options: WebSocket.EventListenerOptions

Returns void

Parameters

method: "error"

cb: (event: WebSocket.ErrorEvent) => void

Parameters

event: WebSocket.ErrorEvent

Returns void

Optional options: WebSocket.EventListenerOptions

Returns void

Parameters

method: "open"

cb: (event: WebSocket.Event) => void