WebSocket | socketit

Hierarchy

EventEmitter
- WebSocket

Index

Constructors

constructor

Properties

Constructors

constructor

new WebSocket(address: string | url.URL, options?: ClientOptions | http.ClientRequestArgs): WebSocket
new WebSocket(address: string | url.URL, protocols?: string | string[], options?: ClientOptions | http.ClientRequestArgs): WebSocket

- Defined in node_modules/@types/ws/index.d.ts:45
Parameters
- address: string | url.URL
- Optional options: ClientOptions | http.ClientRequestArgs
Returns WebSocket
- Defined in node_modules/@types/ws/index.d.ts:47
Parameters
- address: string | url.URL
- Optional protocols: string | string[]
- Optional options: ClientOptions | http.ClientRequestArgs
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: (event: CloseEvent) => void

Type declaration

- (event: CloseEvent): void
- Parameters
  - event: CloseEvent
  Returns void

onerror

onerror: (event: ErrorEvent) => void

Type declaration

- (event: ErrorEvent): void
- Parameters
  - event: ErrorEvent
  Returns void

onmessage

onmessage: (event: MessageEvent) => void

Type declaration

- (event: MessageEvent): void
- Parameters
  - event: MessageEvent
  Returns void

onopen

onopen: (event: OpenEvent) => void

Type declaration

- (event: OpenEvent): void
- Parameters
  - event: OpenEvent
  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

Readonly Static errorMonitor

errorMonitor: unique symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Methods

addEventListener

addEventListener(method: "message", cb: (event: { data: any; target: WebSocket; type: string }) => void, options?: EventListenerOptions): void
addEventListener(method: "close", cb: (event: { code: number; reason: string; target: WebSocket; wasClean: boolean }) => void, options?: EventListenerOptions): void
addEventListener(method: "error", cb: (event: { error: any; message: any; target: WebSocket; type: string }) => void, options?: EventListenerOptions): void
addEventListener(method: "open", cb: (event: { target: WebSocket }) => void, options?: EventListenerOptions): void
addEventListener(method: string, listener: () => void, options?: EventListenerOptions): void

- Defined in node_modules/@types/ws/index.d.ts:58
Parameters
- method: "message"
- cb: (event: { data: any; target: WebSocket; type: string }) => void
  - - (event: { data: any; target: WebSocket; type: string }): void
    - Parameters
      - event: { data: any; target: WebSocket; type: string }
        
        data: any
        
        target: WebSocket
        
        type: string
      Returns void
- Optional options: EventListenerOptions
Returns void
- Defined in node_modules/@types/ws/index.d.ts:63
Parameters
- method: "close"
- cb: (event: { code: number; reason: string; target: WebSocket; wasClean: boolean }) => void
  - - (event: { code: number; reason: string; target: WebSocket; wasClean: boolean }): void
    - Parameters
      - event: { code: number; reason: string; target: WebSocket; wasClean: boolean }
        
        code: number
        
        reason: string
        
        target: WebSocket
        
        wasClean: boolean
      Returns void
- Optional options: EventListenerOptions
Returns void
- Defined in node_modules/@types/ws/index.d.ts:67
Parameters
- method: "error"
- cb: (event: { error: any; message: any; target: WebSocket; type: string }) => void
  - - (event: { error: any; message: any; target: WebSocket; type: string }): void
    - Parameters
      - event: { error: any; message: any; target: WebSocket; type: string }
        
        error: any
        
        message: any
        
        target: WebSocket
        
        type: string
      Returns void
- Optional options: EventListenerOptions
Returns void
- Defined in node_modules/@types/ws/index.d.ts:73
Parameters
- method: "open"
- cb: (event: { target: WebSocket }) => void
  - - (event: { target: WebSocket }): void
    - Parameters
      - event: { target: WebSocket }
        
        target: WebSocket
      Returns void
- Optional options: EventListenerOptions
Returns void
- Defined in node_modules/@types/ws/index.d.ts:74
Parameters
- method: string
- listener: () => void
  - - (): void
    - Returns void
- Optional options: EventListenerOptions
Returns void

addListener

addListener(event: "close", listener: (code: number, message: string) => void): this
addListener(event: "error", listener: (err: Error) => void): this
addListener(event: "upgrade", listener: (request: http.IncomingMessage) => void): this
addListener(event: "message", listener: (data: Data) => void): this
addListener(event: "open", listener: () => void): this
addListener(event: "ping" | "pong", listener: (data: Buffer) => void): this
addListener(event: "unexpected-response", listener: (request: http.ClientRequest, response: http.IncomingMessage) => void): this
addListener(event: string | symbol, listener: (...args: any[]) => void): this

- Defined in node_modules/@types/ws/index.d.ts:95
Parameters
- event: "close"
- listener: (code: number, message: string) => void
  - - (code: number, message: string): void
    - Parameters
      - code: number
      - message: string
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:96
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:97
Parameters
- event: "upgrade"
- listener: (request: http.IncomingMessage) => void
  - - (request: http.IncomingMessage): void
    - Parameters
      - request: http.IncomingMessage
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:98
Parameters
- event: "message"
- listener: (data: Data) => void
  - - (data: Data): void
    - Parameters
      - data: Data
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:99
Parameters
- event: "open"
- listener: () => void
  - - (): void
    - Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:100
Parameters
- event: "ping" | "pong"
- listener: (data: Buffer) => void
  - - (data: Buffer): void
    - Parameters
      - data: Buffer
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:101
Parameters
- event: "unexpected-response"
- listener: (request: http.ClientRequest, response: http.IncomingMessage) => void
  - - (request: http.ClientRequest, response: http.IncomingMessage): void
    - Parameters
      - request: http.ClientRequest
      - response: http.IncomingMessage
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:102
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

close

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

- Defined in node_modules/@types/ws/index.d.ts:50
Parameters
- Optional code: number
- Optional data: string
Returns void

emit

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

- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

- Defined in node_modules/@types/node/events.d.ts:69
Returns number

listenerCount

listenerCount(event: string | symbol): number

- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

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

- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: (...args: any[]) => void): this

- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: "close", listener: (code: WebSocket, reason: number) => void): this
on(event: "error", listener: (err: WebSocket) => void): this
on(event: "upgrade", listener: (request: WebSocket) => void): this
on(event: "message", listener: (data: WebSocket) => void): this
on(event: "open", listener: () => void): this
on(event: "ping" | "pong", listener: (data: WebSocket) => void): this
on(event: "unexpected-response", listener: (request: WebSocket, response: http.ClientRequest) => void): this
on(event: string | symbol, listener: (...args: WebSocket) => void): this

- Defined in node_modules/@types/ws/index.d.ts:86
Parameters
- event: "close"
- listener: (code: WebSocket, reason: number) => void
  - - (code: WebSocket, reason: number): void
    - Parameters
      - code: WebSocket
      - reason: number
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:87
Parameters
- event: "error"
- listener: (err: WebSocket) => void
  - - (err: WebSocket): void
    - Parameters
      - err: WebSocket
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:88
Parameters
- event: "upgrade"
- listener: (request: WebSocket) => void
  - - (request: WebSocket): void
    - Parameters
      - request: WebSocket
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:89
Parameters
- event: "message"
- listener: (data: WebSocket) => void
  - - (data: WebSocket): void
    - Parameters
      - data: WebSocket
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:90
Parameters
- event: "open"
- listener: () => void
  - - (): void
    - Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:91
Parameters
- event: "ping" | "pong"
- listener: (data: WebSocket) => void
  - - (data: WebSocket): void
    - Parameters
      - data: WebSocket
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:92
Parameters
- event: "unexpected-response"
- listener: (request: WebSocket, response: http.ClientRequest) => void
  - - (request: WebSocket, response: http.ClientRequest): void
    - Parameters
      - request: WebSocket
      - response: http.ClientRequest
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:93
Parameters
- event: string | symbol
- listener: (...args: WebSocket) => void
  - - (...args: WebSocket): void
    - Parameters
      - Rest ...args: WebSocket
      Returns void
Returns this

once

once(event: string | symbol, listener: (...args: any[]) => void): this

- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

ping

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

- Defined in node_modules/@types/ws/index.d.ts:51
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

- Defined in node_modules/@types/ws/index.d.ts:52
Parameters
- Optional data: any
- Optional mask: boolean
- Optional cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void

prependListener

prependListener(event: string | symbol, listener: (...args: any[]) => void): this

- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): this

- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

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

- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeEventListener

removeEventListener(method: "message", cb?: (event: { data: any; target: WebSocket; type: string }) => void): void
removeEventListener(method: "close", cb?: (event: { code: number; reason: string; target: WebSocket; wasClean: boolean }) => void): void
removeEventListener(method: "error", cb?: (event: { error: any; message: any; target: WebSocket; type: string }) => void): void
removeEventListener(method: "open", cb?: (event: { target: WebSocket }) => void): void
removeEventListener(method: string, listener?: () => void): void

- Defined in node_modules/@types/ws/index.d.ts:76
Parameters
- method: "message"
- Optional cb: (event: { data: any; target: WebSocket; type: string }) => void
  - - (event: { data: any; target: WebSocket; type: string }): void
    - Parameters
      - event: { data: any; target: WebSocket; type: string }
        
        data: any
        
        target: WebSocket
        
        type: string
      Returns void
Returns void
- Defined in node_modules/@types/ws/index.d.ts:77
Parameters
- method: "close"
- Optional cb: (event: { code: number; reason: string; target: WebSocket; wasClean: boolean }) => void
  - - (event: { code: number; reason: string; target: WebSocket; wasClean: boolean }): void
    - Parameters
      - event: { code: number; reason: string; target: WebSocket; wasClean: boolean }
        
        code: number
        
        reason: string
        
        target: WebSocket
        
        wasClean: boolean
      Returns void
Returns void
- Defined in node_modules/@types/ws/index.d.ts:81
Parameters
- method: "error"
- Optional cb: (event: { error: any; message: any; target: WebSocket; type: string }) => void
  - - (event: { error: any; message: any; target: WebSocket; type: string }): void
    - Parameters
      - event: { error: any; message: any; target: WebSocket; type: string }
        
        error: any
        
        message: any
        
        target: WebSocket
        
        type: string
      Returns void
Returns void
- Defined in node_modules/@types/ws/index.d.ts:82
Parameters
- method: "open"
- Optional cb: (event: { target: WebSocket }) => void
  - - (event: { target: WebSocket }): void
    - Parameters
      - event: { target: WebSocket }
        
        target: WebSocket
      Returns void
Returns void
- Defined in node_modules/@types/ws/index.d.ts:83
Parameters
- method: string
- Optional listener: () => void
  - - (): void
    - Returns void
Returns void

removeListener

removeListener(event: "close", listener: (code: number, message: string) => void): this
removeListener(event: "error", listener: (err: Error) => void): this
removeListener(event: "upgrade", listener: (request: http.IncomingMessage) => void): this
removeListener(event: "message", listener: (data: Data) => void): this
removeListener(event: "open", listener: () => void): this
removeListener(event: "ping" | "pong", listener: (data: Buffer) => void): this
removeListener(event: "unexpected-response", listener: (request: http.ClientRequest, response: http.IncomingMessage) => void): this
removeListener(event: string | symbol, listener: (...args: any[]) => void): this

- Defined in node_modules/@types/ws/index.d.ts:104
Parameters
- event: "close"
- listener: (code: number, message: string) => void
  - - (code: number, message: string): void
    - Parameters
      - code: number
      - message: string
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:105
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:106
Parameters
- event: "upgrade"
- listener: (request: http.IncomingMessage) => void
  - - (request: http.IncomingMessage): void
    - Parameters
      - request: http.IncomingMessage
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:107
Parameters
- event: "message"
- listener: (data: Data) => void
  - - (data: Data): void
    - Parameters
      - data: Data
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:108
Parameters
- event: "open"
- listener: () => void
  - - (): void
    - Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:109
Parameters
- event: "ping" | "pong"
- listener: (data: Buffer) => void
  - - (data: Buffer): void
    - Parameters
      - data: Buffer
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:110
Parameters
- event: "unexpected-response"
- listener: (request: http.ClientRequest, response: http.IncomingMessage) => void
  - - (request: http.ClientRequest, response: http.IncomingMessage): void
    - Parameters
      - request: http.ClientRequest
      - response: http.IncomingMessage
      Returns void
Returns this
- Defined in node_modules/@types/ws/index.d.ts:111
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

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

- Defined in node_modules/@types/ws/index.d.ts:53
Parameters
- data: any
- Optional cb: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void
- Defined in node_modules/@types/ws/index.d.ts:54
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

setMaxListeners

setMaxListeners(n: number): this

- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

terminate

terminate(): void

- Defined in node_modules/@types/ws/index.d.ts:55
Returns void

Static listenerCount

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

- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

address: string | url.URL

Optional options: ClientOptions | http.ClientRequestArgs

Returns WebSocket

Parameters

address: string | url.URL

Optional protocols: string | string[]

Optional options: ClientOptions | http.ClientRequestArgs

Returns WebSocket

Properties

CLOSED

CLOSING

CONNECTING

OPEN

binaryType

bufferedAmount

extensions

onclose

Type declaration

Parameters

event: CloseEvent

Returns void

onerror

Type declaration

Parameters

event: ErrorEvent

Returns void

onmessage

Type declaration

Parameters

event: MessageEvent

Returns void

onopen

Type declaration

Parameters

event: OpenEvent

Returns void

protocol

readyState

url

Static CLOSED

Static CLOSING

Static CONNECTING

Static OPEN

Static defaultMaxListeners

Readonly Static errorMonitor

Methods

addEventListener

Parameters

method: "message"

cb: (event: { data: any; target: WebSocket; type: string }) => void

Parameters

event: { data: any; target: WebSocket; type: string }

data: any

target: WebSocket

type: string

Returns void

Optional options: EventListenerOptions

Returns void

Parameters

method: "close"

cb: (event: { code: number; reason: string; target: WebSocket; wasClean: boolean }) => void

Parameters

event: { code: number; reason: string; target: WebSocket; wasClean: boolean }

code: number

reason: string

target: WebSocket

wasClean: boolean

Returns void

Optional options: EventListenerOptions

Returns void

Parameters

method: "error"