Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface WebSocket

Hierarchy

Index

Properties

Methods

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

Readonly isPaused

isPaused: boolean

Indicates whether the websocket is paused

onclose

onclose: null | ((event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".CloseEvent) => void)

onerror

onerror: null | ((event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".ErrorEvent) => void)

onmessage

onmessage: null | ((event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".MessageEvent) => void)

onopen

onopen: null | ((event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Event) => void)

Readonly protocol

protocol: string

Readonly readyState

readyState: 0 | 1 | 2 | 3

The current state of the connection

Readonly url

url: string

Methods

addEventListener

addListener

close

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

  • Parameters

    • Optional code: number
    • Optional data: string | Buffer

    Returns void

off

on

once

pause

  • pause(): void

  • Pause the websocket causing it to stop emitting events. Some events can still be emitted after this is called, until all buffered data is consumed. This method is a noop if the ready state is CONNECTING or CLOSED.

    Returns void

ping

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

  • 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

  • Parameters

    • Optional data: any
    • Optional mask: boolean
    • Optional cb: (err: Error) => void
        • (err: Error): void

        • Parameters

          • err: Error

          Returns void

    Returns void

removeEventListener

removeListener

resume

  • resume(): void

  • Make a paused socket resume emitting events. This method is a noop if the ready state is CONNECTING or CLOSED.

    Returns void

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

  • Parameters

    • data: any
    • Optional cb: (err?: Error) => void
        • (err?: Error): void

        • Parameters

          • Optional err: Error

          Returns void

    Returns void

  • 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

  • Returns void