Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Type aliases

Static CertMeta

CertMeta: string | string[] | Buffer | Buffer[]

CertMeta represents the accepted types for certificate & key data.

Static Data

Data: string | Buffer | ArrayBuffer | Buffer[]

Data represents the message payload received over the WebSocket.

Static VerifyClientCallbackAsync

VerifyClientCallbackAsync: function

VerifyClientCallbackAsync is an asynchronous callback used to inspect the incoming message. The return value (boolean) of the function determines whether or not to accept the handshake.

Type declaration

    • (info: object, callback: function): void
    • Parameters

      • info: object
      • callback: function
          • (res: boolean, code?: undefined | number, message?: undefined | string): void
          • Parameters

            • res: boolean
            • Optional code: undefined | number
            • Optional message: undefined | string

            Returns void

      Returns void

Static VerifyClientCallbackSync

VerifyClientCallbackSync: function

VerifyClientCallbackSync is a synchronous callback used to inspect the incoming message. The return value (boolean) of the function determines whether or not to accept the handshake.

Type declaration

    • (info: object): boolean
    • Parameters

      Returns boolean

Constructors

constructor

  • Parameters

    Returns WebSocket

  • Parameters

    • address: string
    • Optional protocols: string | string[]
    • Optional options: ClientOptions

    Returns WebSocket

Properties

CLOSED

CLOSED: number

CLOSING

CLOSING: number

CONNECTING

CONNECTING: number

OPEN

OPEN: number

binaryType

binaryType: string

bufferedAmount

bufferedAmount: number

extensions

extensions: string

onclose

onclose: function

Type declaration

    • (event: object): void
    • Parameters

      • event: object
        • code: number
        • reason: string
        • target: WebSocket
        • wasClean: boolean

      Returns void

onerror

onerror: function

Type declaration

    • (event: object): void
    • Parameters

      • event: object
        • error: any
        • message: string
        • target: WebSocket
        • type: string

      Returns void

onmessage

onmessage: function

Type declaration

    • (event: object): void
    • Parameters

      Returns void

onopen

onopen: function

Type declaration

    • (event: object): void
    • Parameters

      Returns void

protocol

protocol: string

readyState

readyState: number

url

url: string

Static CLOSED

CLOSED: number

Static CLOSING

CLOSING: number

Static CONNECTING

CONNECTING: number

Static OPEN

OPEN: number

Static defaultMaxListeners

defaultMaxListeners: number

Methods

addEventListener

  • addEventListener(method: "message", cb?: undefined | function): void
  • addEventListener(method: "close", cb?: undefined | function): void
  • addEventListener(method: "error", cb?: undefined | function): void
  • addEventListener(method: "open", cb?: undefined | function): void
  • addEventListener(method: string, listener?: undefined | function): void
  • Parameters

    • method: "message"
    • Optional cb: undefined | function

    Returns void

  • Parameters

    • method: "close"
    • Optional cb: undefined | function

    Returns void

  • Parameters

    • method: "error"
    • Optional cb: undefined | function

    Returns void

  • Parameters

    • method: "open"
    • Optional cb: undefined | function

    Returns void

  • Parameters

    • method: string
    • Optional listener: undefined | function

    Returns void

addListener

  • addListener(event: "close", listener: function): this
  • addListener(event: "error", listener: function): this
  • addListener(event: "upgrade", listener: function): this
  • addListener(event: "message", listener: function): this
  • addListener(event: "open", listener: function): this
  • addListener(event: "ping" | "pong", listener: function): this
  • addListener(event: "unexpected-response", listener: function): this
  • addListener(event: string | symbol, listener: function): this
  • Parameters

    • event: "close"
    • listener: function
        • (code: number, message: string): void
        • Parameters

          • code: number
          • message: string

          Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    Returns this

  • Parameters

    • event: "message"
    • listener: function
        • (data: Data): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "open"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "ping" | "pong"
    • listener: function

    Returns this

  • Parameters

    Returns this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

close

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

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

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): Array<string | symbol>

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(type: string | symbol): number

listeners

  • listeners(event: string | symbol): Function[]

off

  • off(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

on

  • on(event: "close", listener: function): this
  • on(event: "error", listener: function): this
  • on(event: "upgrade", listener: function): this
  • on(event: "message", listener: function): this
  • on(event: "open", listener: function): this
  • on(event: "ping" | "pong", listener: function): this
  • on(event: "unexpected-response", listener: function): this
  • on(event: string | symbol, listener: function): this
  • Parameters

    • event: "close"
    • listener: function
        • (this: WebSocket, code: number, reason: string): void
        • Parameters

          • this: WebSocket
          • code: number
          • reason: string

          Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function

    Returns this

  • Parameters

    Returns this

  • Parameters

    Returns this

  • Parameters

    • event: "open"
    • listener: function

    Returns this

  • Parameters

    Returns this

  • Parameters

    Returns this

  • Parameters

    • event: string | symbol
    • listener: function
        • Parameters

          Returns void

    Returns this

once

  • once(event: string | symbol, listener: function): this
  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

ping

  • ping(data?: any, mask?: undefined | false | true, cb?: undefined | function): void
  • Parameters

    • Optional data: any
    • Optional mask: undefined | false | true
    • Optional cb: undefined | function

    Returns void

pong

  • pong(data?: any, mask?: undefined | false | true, cb?: undefined | function): void
  • Parameters

    • Optional data: any
    • Optional mask: undefined | false | true
    • Optional cb: undefined | function

    Returns void

prependListener

  • prependListener(event: string | symbol, listener: function): this

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: function): this

rawListeners

  • rawListeners(event: string | symbol): Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): this

removeEventListener

  • removeEventListener(method: "message", cb?: undefined | function): void
  • removeEventListener(method: "close", cb?: undefined | function): void
  • removeEventListener(method: "error", cb?: undefined | function): void
  • removeEventListener(method: "open", cb?: undefined | function): void
  • removeEventListener(method: string, listener?: undefined | function): void
  • Parameters

    • method: "message"
    • Optional cb: undefined | function

    Returns void

  • Parameters

    • method: "close"
    • Optional cb: undefined | function

    Returns void

  • Parameters

    • method: "error"
    • Optional cb: undefined | function

    Returns void

  • Parameters

    • method: "open"
    • Optional cb: undefined | function

    Returns void

  • Parameters

    • method: string
    • Optional listener: undefined | function

    Returns void

removeListener

  • removeListener(event: "close", listener: function): this
  • removeListener(event: "error", listener: function): this
  • removeListener(event: "upgrade", listener: function): this
  • removeListener(event: "message", listener: function): this
  • removeListener(event: "open", listener: function): this
  • removeListener(event: "ping" | "pong", listener: function): this
  • removeListener(event: "unexpected-response", listener: function): this
  • removeListener(event: string | symbol, listener: function): this
  • Parameters

    • event: "close"
    • listener: function
        • (code: number, message: string): void
        • Parameters

          • code: number
          • message: string

          Returns void

    Returns this

  • Parameters

    • event: "error"
    • listener: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns this

  • Parameters

    Returns this

  • Parameters

    • event: "message"
    • listener: function
        • (data: Data): void
        • Parameters

          Returns void

    Returns this

  • Parameters

    • event: "open"
    • listener: function
        • (): void
        • Returns void

    Returns this

  • Parameters

    • event: "ping" | "pong"
    • listener: function

    Returns this

  • Parameters

    Returns this

  • Parameters

    • event: string | symbol
    • listener: function
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns this

send

  • send(data: any, cb?: undefined | function): void
  • send(data: any, options: object, cb?: undefined | function): void
  • Parameters

    • data: any
    • Optional cb: undefined | function

    Returns void

  • Parameters

    • data: any
    • options: object
      • Optional binary?: undefined | false | true
      • Optional compress?: undefined | false | true
      • Optional fin?: undefined | false | true
      • Optional mask?: undefined | false | true
    • Optional cb: undefined | function

    Returns void

setMaxListeners

  • setMaxListeners(n: number): this

terminate

  • terminate(): void
  • Returns void

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number
  • deprecated

    since v4.0.0

    Parameters

    Returns number

Generated using TypeDoc