hydrated-ws
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Implements

  • WebSocket

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new RoutedWebSocket(routerSend: (data: string | ArrayBuffer | Blob | ArrayBufferView) => void, routerClose: (code: number, reason: string) => void, onMessageSubscribe?: (ws: RoutedWebSocket) => void, onMessageUnsubscribe?: (ws: RoutedWebSocket) => void): RoutedWebSocket

Properties

Readonly CLOSED

CLOSED: number = WebSocket.CLOSED

The connection is closed or couldn't be opened.

Readonly CLOSING

CLOSING: number = WebSocket.CLOSING

The connection is in the process of closing.

Readonly CONNECTING

CONNECTING: number = WebSocket.CONNECTING

The connection is not yet open.

Readonly OPEN

OPEN: number = WebSocket.OPEN

The connection is open and ready to communicate.

Protected _readyState

_readyState: number = WebSocket.CONNECTING

binaryType

binaryType: "blob" | "arraybuffer"

A string indicating the type of binary data being transmitted by the connection. This should be either "blob" if DOM Blob objects are being used or "arraybuffer" if ArrayBuffer objects are being used.

Protected closing

closing: boolean = false

Protected listeners

listeners: Dict<keyof IHydratedWebSocketEventMap, Array<{ listener: (this: WebSocket, ev: IHydratedWebSocketEventMap[keyof IHydratedWebSocketEventMap]) => any; useCapture?: boolean }>> = new Dict()

Protected ws

ws: WebSocket

Accessors

bufferedAmount

  • get bufferedAmount(): number

extensions

  • get extensions(): string

onclose

  • get onclose(): (ev: CloseEvent) => any
  • set onclose(f: (ev: CloseEvent) => any): void

  • An event listener to be called when the WebSocket connection's readyState changes to CLOSED. The listener receives a CloseEvent named "close".

    Returns (ev: CloseEvent) => any

      • (ev: CloseEvent): any

      • Parameters

        • ev: CloseEvent

        Returns any

  • An event listener to be called when the WebSocket connection's readyState changes to CLOSED. The listener receives a CloseEvent named "close".

    Parameters

    • f: (ev: CloseEvent) => any
        • (ev: CloseEvent): any

        • Parameters

          • ev: CloseEvent

          Returns any

    Returns void

onerror

  • get onerror(): (ev: Event) => any
  • set onerror(f: (ev: Event) => any): void

  • An event listener to be called when an error occurs. This is a simple event named "error".

    Returns (ev: Event) => any

      • (ev: Event): any

      • Parameters

        • ev: Event

        Returns any

  • An event listener to be called when an error occurs. This is a simple event named "error".

    Parameters

    • f: (ev: Event) => any
        • (ev: Event): any

        • Parameters

          • ev: Event

          Returns any

    Returns void

onmessage

  • get onmessage(): (ev: MessageEvent) => any
  • set onmessage(f: (ev: MessageEvent) => any): void

onopen

  • get onopen(): (ev: Event) => any
  • set onopen(f: (ev: Event) => any): void

  • An event listener to be called when the WebSocket connection's readyState changes to OPEN; this indicates that the connection is ready to send and receive data. The event is a simple one with the name "open".

    Returns (ev: Event) => any

      • (ev: Event): any

      • Parameters

        • ev: Event

        Returns any

  • An event listener to be called when the WebSocket connection's readyState changes to OPEN; this indicates that the connection is ready to send and receive data. The event is a simple one with the name "open".

    Parameters

    • f: (ev: Event) => any
        • (ev: Event): any

        • Parameters

          • ev: Event

          Returns any

    Returns void

protocol

  • get protocol(): string

readyState

  • get readyState(): number

  • The current state of the connection; this is one of the Ready state constants. Read only.

    Returns number

url

  • get url(): string

Methods

addEventListener

  • addEventListener<K>(type: K, listener: (this: WebSocket, ev: IHydratedWebSocketEventMap[K]) => any, useCapture?: boolean): void

close

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

dispatchEvent

  • dispatchEvent(evt: Event): boolean

  • Dispatch an event to this EventTarget.

    Parameters

    • evt: Event

    Returns boolean

    The return value is false if event is cancelable and at least one of the event handlers which handled this event called Event.preventDefault(). Otherwise it returns true.

emitMessage

  • emitMessage(event: MessageEvent): void

Protected forwardEvents

  • forwardEvents<K>(list?: K[]): void

Protected getOnmessage

  • getOnmessage(): (ev: MessageEvent) => any

Protected getReadyState

  • getReadyState(): number

removeEventListener

  • removeEventListener<K>(type: K, listener: (this: WebSocket, ev: IHydratedWebSocketEventMap[K]) => any, useCapture?: boolean): void

send

  • send(data: string | ArrayBuffer | Blob | ArrayBufferView): void

Protected setOnmessage

  • setOnmessage(f: (ev: MessageEvent) => any): void

  • Parameters

    • f: (ev: MessageEvent) => any
        • (ev: MessageEvent): any

        • Parameters

          • ev: MessageEvent

          Returns any

    Returns void

setReadyState

  • setReadyState(state: number): void

Protected stopForwardingEvents

  • stopForwardingEvents(): void

Legend

  • Constructor
  • Property
  • Method
  • Accessor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Property
  • Method
  • Protected property
  • Protected method
  • Static property
  • Static method

Generated using TypeDoc