Interface WebSocket

Provides the API for creating and managing a WebSocket connection to a server, as well as for sending and receiving data on the connection.

Hierarchy

EventTarget
- WebSocket

Index

Properties

Methods

Properties

CLOSED

CLOSED: number

CLOSING

CLOSING: number

CONNECTING

CONNECTING: number

EventTarget

EventTarget: object

Type declaration

constructor: function
- new __type(): EventTarget
- - Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5534
  Returns EventTarget
prototype: EventTarget

OPEN

OPEN: number

binaryType

binaryType: BinaryType

bufferedAmount

bufferedAmount: number

extensions

extensions: string

onclose

onclose: function | null

onerror

onerror: function | null

onmessage

onmessage: function | null

onopen

onopen: function | null

protocol

protocol: string

readyState

readyState: number

url

url: string

Methods

addEventListener

addEventListener<K>(type: K, listener: function, options?: boolean | AddEventListenerOptions): void
addEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | AddEventListenerOptions): void

Overrides EventTarget.addEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:18400
Type parameters
- K: keyof WebSocketEventMap
Parameters
- type: K
- listener: function
  - - (this: WebSocket, ev: WebSocketEventMap[K]): any
    - Parameters
      - this: WebSocket
      - ev: WebSocketEventMap[K]
      Returns any
- Optional options: boolean | AddEventListenerOptions
Returns void
Overrides EventTarget.addEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:18401
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | AddEventListenerOptions
Returns void

close

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

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:18394
Parameters
- Optional code: number
- Optional reason: string
Returns void

dispatchEvent

dispatchEvent(event: Event): boolean

Inherited from EventTarget.dispatchEvent
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:5526
Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Parameters
- event: Event
Returns boolean

removeEventListener

removeEventListener<K>(type: K, listener: function, options?: boolean | EventListenerOptions): void
removeEventListener(type: string, listener: EventListenerOrEventListenerObject, options?: boolean | EventListenerOptions): void

Overrides EventTarget.removeEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:18402
Type parameters
- K: keyof WebSocketEventMap
Parameters
- type: K
- listener: function
  - - (this: WebSocket, ev: WebSocketEventMap[K]): any
    - Parameters
      - this: WebSocket
      - ev: WebSocketEventMap[K]
      Returns any
- Optional options: boolean | EventListenerOptions
Returns void
Overrides EventTarget.removeEventListener
- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:18403
Parameters
- type: string
- listener: EventListenerOrEventListenerObject
- Optional options: boolean | EventListenerOptions
Returns void

send

send(data: string | ArrayBufferLike | Blob | ArrayBufferView): void

- Defined in node_modules/typedoc/node_modules/typescript/lib/lib.dom.d.ts:18395
Parameters
- data: string | ArrayBufferLike | Blob | ArrayBufferView
Returns void

Generated using TypeDoc