WebSocketServer | Electron Forge

Hierarchy

"/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Server
- WebSocketServer

Index

Properties

Methods

Properties

clients

clients: Set<"/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket>

options

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

path

path: string

Methods

addListener

addListener(event: "connection", cb: (client: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket, request: IncomingMessage) => void): "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer
addListener(event: "error", cb: (err: Error) => void): "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer
addListener(event: "headers", cb: (headers: string[], request: IncomingMessage) => void): "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer
addListener(event: "close" | "listening", cb: () => void): "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer
addListener(event: string | symbol, listener: (...args: any[]) => void): "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer

Inherited from Server.addListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:355
Parameters
- event: "connection"
- cb: (client: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket, request: IncomingMessage) => void
  - - (client: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket, request: IncomingMessage): void
    - Parameters
      - client: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket
      - request: IncomingMessage
      Returns void
Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer
Inherited from Server.addListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:356
Parameters
- event: "error"
- cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer
Inherited from Server.addListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:357
Parameters
- event: "headers"
- cb: (headers: string[], request: IncomingMessage) => void
  - - (headers: string[], request: IncomingMessage): void
    - Parameters
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer
Inherited from Server.addListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:358
Parameters
- event: "close" | "listening"
- cb: () => void
  - - (): void
    - Returns void
Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer
Inherited from Server.addListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:359
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer

address

address(): string | "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".AddressInfo

Inherited from Server.address
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:326
Returns string | "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".AddressInfo

close

close(cb?: (err?: Error) => void): void

Inherited from Server.close
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:327
Parameters
- Optional cb: (err?: Error) => void
  - - (err?: Error): void
    - Parameters
      - Optional err: Error
      Returns void
Returns void

handleUpgrade

handleUpgrade(request: IncomingMessage, socket: Duplex, upgradeHead: Buffer, callback: (client: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket, request: IncomingMessage) => void): void

Inherited from Server.handleUpgrade
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:328
Parameters
- request: IncomingMessage
- socket: Duplex
- upgradeHead: Buffer
- callback: (client: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket, request: IncomingMessage) => void
  - - (client: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket, request: IncomingMessage): void
    - Parameters
      - client: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket
      - request: IncomingMessage
      Returns void
Returns void

Inherited from Server.removeListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:361
Parameters
- event: "connection"
- cb: (client: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket) => void
  - - (client: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket): void
    - Parameters
      - client: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket
      Returns void
Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer
Inherited from Server.removeListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:362
Parameters
- event: "error"
- cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer
Inherited from Server.removeListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:363
Parameters
- event: "headers"
- cb: (headers: string[], request: IncomingMessage) => void
  - - (headers: string[], request: IncomingMessage): void
    - Parameters
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer
Inherited from Server.removeListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:364
Parameters
- event: "close" | "listening"
- cb: () => void
  - - (): void
    - Returns void
Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer
Inherited from Server.removeListener
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:365
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer

shouldHandle

shouldHandle(request: IncomingMessage): boolean | Promise<boolean>

Inherited from Server.shouldHandle
- Defined in node_modules/webpack-dev-server/node_modules/@types/ws/index.d.ts:334
Parameters
- request: IncomingMessage
Returns boolean | Promise<boolean>

Hierarchy

Index

Properties

Methods

Properties

clients

options

path

Methods

addListener

Parameters

event: "connection"

cb: (client: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket, request: IncomingMessage) => void

Parameters

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

request: IncomingMessage

Returns void

Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer

Parameters

event: "error"

cb: (err: Error) => void

Parameters

err: Error

Returns void

Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer

Parameters

event: "headers"

cb: (headers: string[], request: IncomingMessage) => void

Parameters

headers: string[]

request: IncomingMessage

Returns void

Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer

Parameters

event: "close" | "listening"

cb: () => void

Returns void

Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer

Parameters

event: string | symbol

listener: (...args: any[]) => void

Parameters

Rest ...args: any[]

Returns void

Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer

address

Returns string | "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".AddressInfo

close

Parameters

Optional cb: (err?: Error) => void

Parameters

Optional err: Error

Returns void

Returns void

handleUpgrade

Parameters

request: IncomingMessage

socket: Duplex

upgradeHead: Buffer

callback: (client: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket, request: IncomingMessage) => void

Parameters

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

request: IncomingMessage

Returns void

Returns void

off

Parameters

event: "connection"

Parameters

this: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Server<"/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket>

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

request: IncomingMessage

Returns void

Returns "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocketServer

Parameters

event: "error"

cb: (this: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Server<"/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket>, error: Error) => void

Parameters

this: "/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".Server<"/home/runner/work/forge/forge/node_modules/webpack-dev-server/node_modules/@types/ws/index".WebSocket>

error: Error