WebSocketAlias | Electron Forge

Hierarchy

WebSocket
- WebSocketAlias

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

Readonly protocol

protocol: string

Readonly readyState

readyState: 0 | 1 | 2 | 3

The current state of the connection

Readonly url

url: string

Methods

addEventListener

addEventListener(method: "message", cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".MessageEvent) => void, options?: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".EventListenerOptions): void
addEventListener(method: "close", cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".CloseEvent) => void, options?: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".EventListenerOptions): void
addEventListener(method: "error", cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".ErrorEvent) => void, options?: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".EventListenerOptions): void
addEventListener(method: "open", cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Event) => void, options?: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".EventListenerOptions): void

Inherited from WebSocket.addEventListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:101
Parameters
- method: "message"
- cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".MessageEvent) => void
  - - (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".MessageEvent): void
    - Parameters
      - event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".MessageEvent
      Returns void
- Optional options: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".EventListenerOptions
Returns void
Inherited from WebSocket.addEventListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:106
Parameters
- method: "close"
- cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".CloseEvent) => void
  - - (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".CloseEvent): void
    - Parameters
      - event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".CloseEvent
      Returns void
- Optional options: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".EventListenerOptions
Returns void
Inherited from WebSocket.addEventListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:111
Parameters
- method: "error"
- cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".ErrorEvent) => void
  - - (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".ErrorEvent): void
    - Parameters
      - event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".ErrorEvent
      Returns void
- Optional options: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".EventListenerOptions
Returns void
Inherited from WebSocket.addEventListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:116
Parameters
- method: "open"
- cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Event) => void
  - - (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Event): void
    - Parameters
      - event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Event
      Returns void
- Optional options: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".EventListenerOptions
Returns void

addListener

addListener(event: "close", listener: (code: number, reason: Buffer) => void): WebSocketAlias
addListener(event: "error", listener: (err: Error) => void): WebSocketAlias
addListener(event: "upgrade", listener: (request: IncomingMessage) => void): WebSocketAlias
addListener(event: "message", listener: (data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean) => void): WebSocketAlias
addListener(event: "open", listener: () => void): WebSocketAlias
addListener(event: "ping" | "pong", listener: (data: Buffer) => void): WebSocketAlias
addListener(event: "unexpected-response", listener: (request: ClientRequest, response: IncomingMessage) => void): WebSocketAlias
addListener(event: string | symbol, listener: (...args: any[]) => void): WebSocketAlias

Inherited from WebSocket.addListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:164
Parameters
- event: "close"
- listener: (code: number, reason: Buffer) => void
  - - (code: number, reason: Buffer): void
    - Parameters
      - code: number
      - reason: Buffer
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.addListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:165
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.addListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:166
Parameters
- event: "upgrade"
- listener: (request: IncomingMessage) => void
  - - (request: IncomingMessage): void
    - Parameters
      - request: IncomingMessage
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.addListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:167
Parameters
- event: "message"
- listener: (data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean) => void
  - - (data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean): void
    - Parameters
      - data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData
      - isBinary: boolean
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.addListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:168
Parameters
- event: "open"
- listener: () => void
  - - (): void
    - Returns void
Returns WebSocketAlias
Inherited from WebSocket.addListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:169
Parameters
- event: "ping" | "pong"
- listener: (data: Buffer) => void
  - - (data: Buffer): void
    - Parameters
      - data: Buffer
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.addListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:170
Parameters
- event: "unexpected-response"
- listener: (request: ClientRequest, response: IncomingMessage) => void
  - - (request: ClientRequest, response: IncomingMessage): void
    - Parameters
      - request: ClientRequest
      - response: IncomingMessage
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.addListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:174
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns WebSocketAlias

close

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

Inherited from WebSocket.close
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:77
Parameters
- Optional code: number
- Optional data: string | Buffer
Returns void

off

off(event: "close", listener: (this: WebSocket, code: number, reason: Buffer) => void): WebSocketAlias
off(event: "error", listener: (this: WebSocket, err: Error) => void): WebSocketAlias
off(event: "upgrade", listener: (this: WebSocket, request: IncomingMessage) => void): WebSocketAlias
off(event: "message", listener: (this: WebSocket, data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean) => void): WebSocketAlias
off(event: "open", listener: (this: WebSocket) => void): WebSocketAlias
off(event: "ping" | "pong", listener: (this: WebSocket, data: Buffer) => void): WebSocketAlias
off(event: "unexpected-response", listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void): WebSocketAlias
off(event: string | symbol, listener: (this: WebSocket, ...args: any[]) => void): WebSocketAlias

Inherited from WebSocket.off
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:152
Parameters
- event: "close"
- listener: (this: WebSocket, code: number, reason: Buffer) => void
  - - (this: WebSocket, code: number, reason: Buffer): void
    - Parameters
      - this: WebSocket
      - code: number
      - reason: Buffer
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.off
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:153
Parameters
- event: "error"
- listener: (this: WebSocket, err: Error) => void
  - - (this: WebSocket, err: Error): void
    - Parameters
      - this: WebSocket
      - err: Error
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.off
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:154
Parameters
- event: "upgrade"
- listener: (this: WebSocket, request: IncomingMessage) => void
  - - (this: WebSocket, request: IncomingMessage): void
    - Parameters
      - this: WebSocket
      - request: IncomingMessage
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.off
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:155
Parameters
- event: "message"
- listener: (this: WebSocket, data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean) => void
  - - (this: WebSocket, data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean): void
    - Parameters
      - this: WebSocket
      - data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData
      - isBinary: boolean
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.off
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:156
Parameters
- event: "open"
- listener: (this: WebSocket) => void
  - - (this: WebSocket): void
    - Parameters
      - this: WebSocket
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.off
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:157
Parameters
- event: "ping" | "pong"
- listener: (this: WebSocket, data: Buffer) => void
  - - (this: WebSocket, data: Buffer): void
    - Parameters
      - this: WebSocket
      - data: Buffer
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.off
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:158
Parameters
- event: "unexpected-response"
- listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void
  - - (this: WebSocket, request: ClientRequest, response: IncomingMessage): void
    - Parameters
      - this: WebSocket
      - request: ClientRequest
      - response: IncomingMessage
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.off
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:162
Parameters
- event: string | symbol
- listener: (this: WebSocket, ...args: any[]) => void
  - - (this: WebSocket, ...args: any[]): void
    - Parameters
      - this: WebSocket
      - Rest ...args: any[]
      Returns void
Returns WebSocketAlias

on

on(event: "close", listener: (this: WebSocket, code: number, reason: Buffer) => void): WebSocketAlias
on(event: "error", listener: (this: WebSocket, err: Error) => void): WebSocketAlias
on(event: "upgrade", listener: (this: WebSocket, request: IncomingMessage) => void): WebSocketAlias
on(event: "message", listener: (this: WebSocket, data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean) => void): WebSocketAlias
on(event: "open", listener: (this: WebSocket) => void): WebSocketAlias
on(event: "ping" | "pong", listener: (this: WebSocket, data: Buffer) => void): WebSocketAlias
on(event: "unexpected-response", listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void): WebSocketAlias
on(event: string | symbol, listener: (this: WebSocket, ...args: any[]) => void): WebSocketAlias

Inherited from WebSocket.on
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:128
Parameters
- event: "close"
- listener: (this: WebSocket, code: number, reason: Buffer) => void
  - - (this: WebSocket, code: number, reason: Buffer): void
    - Parameters
      - this: WebSocket
      - code: number
      - reason: Buffer
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.on
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:129
Parameters
- event: "error"
- listener: (this: WebSocket, err: Error) => void
  - - (this: WebSocket, err: Error): void
    - Parameters
      - this: WebSocket
      - err: Error
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.on
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:130
Parameters
- event: "upgrade"
- listener: (this: WebSocket, request: IncomingMessage) => void
  - - (this: WebSocket, request: IncomingMessage): void
    - Parameters
      - this: WebSocket
      - request: IncomingMessage
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.on
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:131
Parameters
- event: "message"
- listener: (this: WebSocket, data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean) => void
  - - (this: WebSocket, data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean): void
    - Parameters
      - this: WebSocket
      - data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData
      - isBinary: boolean
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.on
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:132
Parameters
- event: "open"
- listener: (this: WebSocket) => void
  - - (this: WebSocket): void
    - Parameters
      - this: WebSocket
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.on
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:133
Parameters
- event: "ping" | "pong"
- listener: (this: WebSocket, data: Buffer) => void
  - - (this: WebSocket, data: Buffer): void
    - Parameters
      - this: WebSocket
      - data: Buffer
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.on
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:134
Parameters
- event: "unexpected-response"
- listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void
  - - (this: WebSocket, request: ClientRequest, response: IncomingMessage): void
    - Parameters
      - this: WebSocket
      - request: ClientRequest
      - response: IncomingMessage
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.on
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:138
Parameters
- event: string | symbol
- listener: (this: WebSocket, ...args: any[]) => void
  - - (this: WebSocket, ...args: any[]): void
    - Parameters
      - this: WebSocket
      - Rest ...args: any[]
      Returns void
Returns WebSocketAlias

once

once(event: "close", listener: (this: WebSocket, code: number, reason: Buffer) => void): WebSocketAlias
once(event: "error", listener: (this: WebSocket, err: Error) => void): WebSocketAlias
once(event: "upgrade", listener: (this: WebSocket, request: IncomingMessage) => void): WebSocketAlias
once(event: "message", listener: (this: WebSocket, data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean) => void): WebSocketAlias
once(event: "open", listener: (this: WebSocket) => void): WebSocketAlias
once(event: "ping" | "pong", listener: (this: WebSocket, data: Buffer) => void): WebSocketAlias
once(event: "unexpected-response", listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void): WebSocketAlias
once(event: string | symbol, listener: (this: WebSocket, ...args: any[]) => void): WebSocketAlias

Inherited from WebSocket.once
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:140
Parameters
- event: "close"
- listener: (this: WebSocket, code: number, reason: Buffer) => void
  - - (this: WebSocket, code: number, reason: Buffer): void
    - Parameters
      - this: WebSocket
      - code: number
      - reason: Buffer
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.once
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:141
Parameters
- event: "error"
- listener: (this: WebSocket, err: Error) => void
  - - (this: WebSocket, err: Error): void
    - Parameters
      - this: WebSocket
      - err: Error
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.once
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:142
Parameters
- event: "upgrade"
- listener: (this: WebSocket, request: IncomingMessage) => void
  - - (this: WebSocket, request: IncomingMessage): void
    - Parameters
      - this: WebSocket
      - request: IncomingMessage
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.once
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:143
Parameters
- event: "message"
- listener: (this: WebSocket, data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean) => void
  - - (this: WebSocket, data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean): void
    - Parameters
      - this: WebSocket
      - data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData
      - isBinary: boolean
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.once
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:144
Parameters
- event: "open"
- listener: (this: WebSocket) => void
  - - (this: WebSocket): void
    - Parameters
      - this: WebSocket
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.once
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:145
Parameters
- event: "ping" | "pong"
- listener: (this: WebSocket, data: Buffer) => void
  - - (this: WebSocket, data: Buffer): void
    - Parameters
      - this: WebSocket
      - data: Buffer
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.once
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:146
Parameters
- event: "unexpected-response"
- listener: (this: WebSocket, request: ClientRequest, response: IncomingMessage) => void
  - - (this: WebSocket, request: ClientRequest, response: IncomingMessage): void
    - Parameters
      - this: WebSocket
      - request: ClientRequest
      - response: IncomingMessage
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.once
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:150
Parameters
- event: string | symbol
- listener: (this: WebSocket, ...args: any[]) => void
  - - (this: WebSocket, ...args: any[]): void
    - Parameters
      - this: WebSocket
      - Rest ...args: any[]
      Returns void
Returns WebSocketAlias

pause

pause(): void

Inherited from WebSocket.pause
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:93
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

Inherited from WebSocket.ping
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:78
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

Inherited from WebSocket.pong
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:79
Parameters
- Optional data: any
- Optional mask: boolean
- Optional cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void

removeEventListener

removeEventListener(method: "message", cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".MessageEvent) => void): void
removeEventListener(method: "close", cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".CloseEvent) => void): void
removeEventListener(method: "error", cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".ErrorEvent) => void): void
removeEventListener(method: "open", cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Event) => void): void

Inherited from WebSocket.removeEventListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:122
Parameters
- method: "message"
- cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".MessageEvent) => void
  - - (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".MessageEvent): void
    - Parameters
      - event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".MessageEvent
      Returns void
Returns void
Inherited from WebSocket.removeEventListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:123
Parameters
- method: "close"
- cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".CloseEvent) => void
  - - (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".CloseEvent): void
    - Parameters
      - event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".CloseEvent
      Returns void
Returns void
Inherited from WebSocket.removeEventListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:124
Parameters
- method: "error"
- cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".ErrorEvent) => void
  - - (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".ErrorEvent): void
    - Parameters
      - event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".ErrorEvent
      Returns void
Returns void
Inherited from WebSocket.removeEventListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:125
Parameters
- method: "open"
- cb: (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Event) => void
  - - (event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Event): void
    - Parameters
      - event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Event
      Returns void
Returns void

removeListener

removeListener(event: "close", listener: (code: number, reason: Buffer) => void): WebSocketAlias
removeListener(event: "error", listener: (err: Error) => void): WebSocketAlias
removeListener(event: "upgrade", listener: (request: IncomingMessage) => void): WebSocketAlias
removeListener(event: "message", listener: (data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean) => void): WebSocketAlias
removeListener(event: "open", listener: () => void): WebSocketAlias
removeListener(event: "ping" | "pong", listener: (data: Buffer) => void): WebSocketAlias
removeListener(event: "unexpected-response", listener: (request: ClientRequest, response: IncomingMessage) => void): WebSocketAlias
removeListener(event: string | symbol, listener: (...args: any[]) => void): WebSocketAlias

Inherited from WebSocket.removeListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:176
Parameters
- event: "close"
- listener: (code: number, reason: Buffer) => void
  - - (code: number, reason: Buffer): void
    - Parameters
      - code: number
      - reason: Buffer
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.removeListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:177
Parameters
- event: "error"
- listener: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.removeListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:178
Parameters
- event: "upgrade"
- listener: (request: IncomingMessage) => void
  - - (request: IncomingMessage): void
    - Parameters
      - request: IncomingMessage
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.removeListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:179
Parameters
- event: "message"
- listener: (data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean) => void
  - - (data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean): void
    - Parameters
      - data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData
      - isBinary: boolean
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.removeListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:180
Parameters
- event: "open"
- listener: () => void
  - - (): void
    - Returns void
Returns WebSocketAlias
Inherited from WebSocket.removeListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:181
Parameters
- event: "ping" | "pong"
- listener: (data: Buffer) => void
  - - (data: Buffer): void
    - Parameters
      - data: Buffer
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.removeListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:182
Parameters
- event: "unexpected-response"
- listener: (request: ClientRequest, response: IncomingMessage) => void
  - - (request: ClientRequest, response: IncomingMessage): void
    - Parameters
      - request: ClientRequest
      - response: IncomingMessage
      Returns void
Returns WebSocketAlias
Inherited from WebSocket.removeListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:186
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns WebSocketAlias

resume

resume(): void

Inherited from WebSocket.resume
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:98
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

Inherited from WebSocket.send
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:80
Parameters
- data: any
- Optional cb: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void
Inherited from WebSocket.send
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:81
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

Inherited from WebSocket.terminate
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:86
Returns void

Hierarchy

Index

Properties

Methods

Properties

Readonly CLOSED

Readonly CLOSING

Readonly CONNECTING

Readonly OPEN

binaryType

Readonly bufferedAmount

Readonly extensions

Readonly isPaused

onclose

onerror

onmessage

onopen

Readonly protocol

Readonly readyState

Readonly url

Methods

addEventListener

Parameters

method: "message"

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

Parameters

event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".MessageEvent

Returns void

Optional options: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".EventListenerOptions

Returns void

Parameters

method: "close"

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

Parameters

event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".CloseEvent

Returns void

Optional options: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".EventListenerOptions

Returns void

Parameters

method: "error"

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

Parameters

event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".ErrorEvent

Returns void

Optional options: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".EventListenerOptions

Returns void

Parameters

method: "open"

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

Parameters

event: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Event

Returns void

Optional options: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".EventListenerOptions

Returns void

addListener

Parameters

event: "close"

listener: (code: number, reason: Buffer) => void

Parameters

code: number

reason: Buffer

Returns void

Returns WebSocketAlias

Parameters

event: "error"

listener: (err: Error) => void

Parameters

err: Error

Returns void

Returns WebSocketAlias

Parameters

event: "upgrade"

listener: (request: IncomingMessage) => void

Parameters

request: IncomingMessage

Returns void

Returns WebSocketAlias

Parameters

event: "message"

listener: (data: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".RawData, isBinary: boolean) => void