Server | Electron Forge

Hierarchy

EventEmitter
- Server

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Server(options?: ServerOptions, callback?: () => void): Server

Overrides EventEmitter.constructor
- Defined in node_modules/@types/ws/index.d.ts:305
Parameters
- Optional options: ServerOptions
- Optional callback: () => void
  - - (): void
    - Returns void
Returns Server

Properties

clients

clients: Set<WebSocket>

options

options: ServerOptions

path

path: string

Methods

addListener

addListener(event: "connection", cb: (client: WebSocket, request: IncomingMessage) => void): Server
addListener(event: "error", cb: (err: Error) => void): Server
addListener(event: "headers", cb: (headers: string[], request: IncomingMessage) => void): Server
addListener(event: "close" | "listening", cb: () => void): Server
addListener(event: string | symbol, listener: (...args: any[]) => void): Server

Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:336
Parameters
- event: "connection"
- cb: (client: WebSocket, request: IncomingMessage) => void
  - - (client: WebSocket, request: IncomingMessage): void
    - Parameters
      - client: WebSocket
      - request: IncomingMessage
      Returns void
Returns Server
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:337
Parameters
- event: "error"
- cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Server
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:338
Parameters
- event: "headers"
- cb: (headers: string[], request: IncomingMessage) => void
  - - (headers: string[], request: IncomingMessage): void
    - Parameters
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns Server
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:339
Parameters
- event: "close" | "listening"
- cb: () => void
  - - (): void
    - Returns void
Returns Server
Overrides EventEmitter.addListener
- Defined in node_modules/@types/ws/index.d.ts:340
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Server

address

address(): string | WebSocket.AddressInfo

- Defined in node_modules/@types/ws/index.d.ts:307
Returns string | WebSocket.AddressInfo

close

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

- Defined in node_modules/@types/ws/index.d.ts:308
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: WebSocket, request: IncomingMessage) => void): void

- Defined in node_modules/@types/ws/index.d.ts:309
Parameters
- request: IncomingMessage
- socket: Duplex
- upgradeHead: Buffer
- callback: (client: WebSocket, request: IncomingMessage) => void
  - - (client: WebSocket, request: IncomingMessage): void
    - Parameters
      - client: WebSocket
      - request: IncomingMessage
      Returns void
Returns void

off

off(event: "connection", cb: (this: Server, socket: WebSocket, request: IncomingMessage) => void): Server
off(event: "error", cb: (this: Server, error: Error) => void): Server
off(event: "headers", cb: (this: Server, headers: string[], request: IncomingMessage) => void): Server
off(event: "close" | "listening", cb: (this: Server) => void): Server
off(event: string | symbol, listener: (this: Server, ...args: any[]) => void): Server

Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:330
Parameters
- event: "connection"
- cb: (this: Server, socket: WebSocket, request: IncomingMessage) => void
  - - (this: Server, socket: WebSocket, request: IncomingMessage): void
    - Parameters
      - this: Server
      - socket: WebSocket
      - request: IncomingMessage
      Returns void
Returns Server
Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:331
Parameters
- event: "error"
- cb: (this: Server, error: Error) => void
  - - (this: Server, error: Error): void
    - Parameters
      - this: Server
      - error: Error
      Returns void
Returns Server
Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:332
Parameters
- event: "headers"
- cb: (this: Server, headers: string[], request: IncomingMessage) => void
  - - (this: Server, headers: string[], request: IncomingMessage): void
    - Parameters
      - this: Server
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns Server
Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:333
Parameters
- event: "close" | "listening"
- cb: (this: Server) => void
  - - (this: Server): void
    - Parameters
      - this: Server
      Returns void
Returns Server
Overrides EventEmitter.off
- Defined in node_modules/@types/ws/index.d.ts:334
Parameters
- event: string | symbol
- listener: (this: Server, ...args: any[]) => void
  - - (this: Server, ...args: any[]): void
    - Parameters
      - this: Server
      - Rest ...args: any[]
      Returns void
Returns Server

on

on(event: "connection", cb: (this: Server, socket: WebSocket, request: IncomingMessage) => void): Server
on(event: "error", cb: (this: Server, error: Error) => void): Server
on(event: "headers", cb: (this: Server, headers: string[], request: IncomingMessage) => void): Server
on(event: "close" | "listening", cb: (this: Server) => void): Server
on(event: string | symbol, listener: (this: Server, ...args: any[]) => void): Server

Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:318
Parameters
- event: "connection"
- cb: (this: Server, socket: WebSocket, request: IncomingMessage) => void
  - - (this: Server, socket: WebSocket, request: IncomingMessage): void
    - Parameters
      - this: Server
      - socket: WebSocket
      - request: IncomingMessage
      Returns void
Returns Server
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:319
Parameters
- event: "error"
- cb: (this: Server, error: Error) => void
  - - (this: Server, error: Error): void
    - Parameters
      - this: Server
      - error: Error
      Returns void
Returns Server
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:320
Parameters
- event: "headers"
- cb: (this: Server, headers: string[], request: IncomingMessage) => void
  - - (this: Server, headers: string[], request: IncomingMessage): void
    - Parameters
      - this: Server
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns Server
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:321
Parameters
- event: "close" | "listening"
- cb: (this: Server) => void
  - - (this: Server): void
    - Parameters
      - this: Server
      Returns void
Returns Server
Overrides EventEmitter.on
- Defined in node_modules/@types/ws/index.d.ts:322
Parameters
- event: string | symbol
- listener: (this: Server, ...args: any[]) => void
  - - (this: Server, ...args: any[]): void
    - Parameters
      - this: Server
      - Rest ...args: any[]
      Returns void
Returns Server

once

once(event: "connection", cb: (this: Server, socket: WebSocket, request: IncomingMessage) => void): Server
once(event: "error", cb: (this: Server, error: Error) => void): Server
once(event: "headers", cb: (this: Server, headers: string[], request: IncomingMessage) => void): Server
once(event: "close" | "listening", cb: (this: Server) => void): Server
once(event: string | symbol, listener: (...args: any[]) => void): Server

Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:324
Parameters
- event: "connection"
- cb: (this: Server, socket: WebSocket, request: IncomingMessage) => void
  - - (this: Server, socket: WebSocket, request: IncomingMessage): void
    - Parameters
      - this: Server
      - socket: WebSocket
      - request: IncomingMessage
      Returns void
Returns Server
Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:325
Parameters
- event: "error"
- cb: (this: Server, error: Error) => void
  - - (this: Server, error: Error): void
    - Parameters
      - this: Server
      - error: Error
      Returns void
Returns Server
Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:326
Parameters
- event: "headers"
- cb: (this: Server, headers: string[], request: IncomingMessage) => void
  - - (this: Server, headers: string[], request: IncomingMessage): void
    - Parameters
      - this: Server
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns Server
Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:327
Parameters
- event: "close" | "listening"
- cb: (this: Server) => void
  - - (this: Server): void
    - Parameters
      - this: Server
      Returns void
Returns Server
Overrides EventEmitter.once
- Defined in node_modules/@types/ws/index.d.ts:328
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Server

removeListener

removeListener(event: "connection", cb: (client: WebSocket) => void): Server
removeListener(event: "error", cb: (err: Error) => void): Server
removeListener(event: "headers", cb: (headers: string[], request: IncomingMessage) => void): Server
removeListener(event: "close" | "listening", cb: () => void): Server
removeListener(event: string | symbol, listener: (...args: any[]) => void): Server

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:342
Parameters
- event: "connection"
- cb: (client: WebSocket) => void
  - - (client: WebSocket): void
    - Parameters
      - client: WebSocket
      Returns void
Returns Server
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:343
Parameters
- event: "error"
- cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Server
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:344
Parameters
- event: "headers"
- cb: (headers: string[], request: IncomingMessage) => void
  - - (headers: string[], request: IncomingMessage): void
    - Parameters
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns Server
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:345
Parameters
- event: "close" | "listening"
- cb: () => void
  - - (): void
    - Returns void
Returns Server
Overrides EventEmitter.removeListener
- Defined in node_modules/@types/ws/index.d.ts:346
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Server

shouldHandle

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

- Defined in node_modules/@types/ws/index.d.ts:315
Parameters
- request: IncomingMessage
Returns boolean | Promise<boolean>

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional options: ServerOptions

Optional callback: () => void

Returns void

Returns Server

Properties

clients

options

path

Methods

addListener

Parameters

event: "connection"

cb: (client: WebSocket, request: IncomingMessage) => void

Parameters

client: WebSocket

request: IncomingMessage

Returns void

Returns Server

Parameters

event: "error"

cb: (err: Error) => void

Parameters

err: Error

Returns void

Returns Server

Parameters

event: "headers"

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

Parameters

headers: string[]

request: IncomingMessage

Returns void

Returns Server

Parameters

event: "close" | "listening"

cb: () => void

Returns void

Returns Server

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns Server

address

Returns string | WebSocket.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: WebSocket, request: IncomingMessage) => void

Parameters

client: WebSocket

request: IncomingMessage

Returns void

Returns void

off

Parameters

event: "connection"

cb: (this: Server, socket: WebSocket, request: IncomingMessage) => void

Parameters

this: Server

socket: WebSocket