Class WS

constructor

• new WS(url: UrlProvider, options?: WSOptions): WS

  Parameters

  • url: UrlProvider
  • Optionaloptions: WSOptions = {}

  Returns WS

onclose

onerror

onmessage

onopen

options

binaryType

• get binaryType(): BinaryType

  Returns BinaryType

• set binaryType(type: BinaryType): void

  Returns a string that indicates how binary data from the WebSocket object is exposed to scripts:

  Can be set, to change how binary data is returned. The default is "blob".

  MDN Reference

  Parameters

  • type: BinaryType

  Returns void

bufferedAmount

• get bufferedAmount(): number

  Returns the number of bytes of application data (UTF-8 text and binary data) that have been queued using send() but not yet been transmitted to the network.

  If the WebSocket connection is closed, this attribute's value will only increase with each call to the send() method. (The number does not reset to zero once the connection closes.)

  MDN Reference

  Returns number

CLOSED

• get CLOSED(): number

  Returns number

CLOSING

• get CLOSING(): number

  Returns number

CONNECTING

• get CONNECTING(): number

  Returns number

extensions

• get extensions(): string

  Returns the extensions selected by the server, if any.

  MDN Reference

  Returns string

OPEN

• get OPEN(): number

  Returns number

protocol

• get protocol(): string

  Returns the subprotocol selected by the server, if any. It can be used in conjunction with the array form of the constructor's second argument to perform subprotocol negotiation.

  MDN Reference

  Returns string

readyState

• get readyState(): 0 | 1 | 2 | 3

  Returns the state of the WebSocket object's connection. It can have the values described below.

  MDN Reference

  Returns 0 | 1 | 2 | 3

url

• get url(): string

  Returns the URL that was used to establish the WebSocket connection.

  MDN Reference

  Returns string

StaticCLOSED

• get CLOSED(): number

  Returns number

StaticCLOSING

• get CLOSING(): number

  Returns number

StaticCONNECTING

• get CONNECTING(): number

  Returns number

StaticOPEN

• get OPEN(): number

  Returns number

close

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

  Closes the WebSocket connection, optionally using code as the the WebSocket connection close code and reason as the the WebSocket connection close reason.

  MDN Reference

  Parameters

  • Optionalcode: number = 1000
  • Optionalreason: string

  Returns void

open

• open(): void

  Open the WebSocket connection manual when automaticOpen is false.

  Returns void

  See

  WSOptions

send

• send(data: Data): void

  Transmits data using the WebSocket connection. data can be a string, a Blob, an ArrayBuffer, or an ArrayBufferView.

  MDN Reference

  Parameters

  • data: Data

  Returns void