Server | Electron Forge

Type parameters

T: WebSocket = WebSocket

Hierarchy

EventEmitter
- Server
  - WebSocket.WebSocketServer

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Server<T>(options?: WebSocket.ServerOptions, callback?: () => void): Server<T>

Overrides EventEmitter.constructor
- Defined in node_modules/vite/dist/node/index.d.ts:1305
Type parameters
- T: WebSocket<T> = WebSocket
Parameters
- Optional options: WebSocket.ServerOptions
- Optional callback: () => void
  - - (): void
    - Returns void
Returns Server<T>

Properties

clients

clients: Set<T>

options

options: WebSocket.ServerOptions

path

path: string

Methods

addListener

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

Overrides EventEmitter.addListener
- Defined in node_modules/vite/dist/node/index.d.ts:1375
Parameters
- event: "connection"
- cb: (client: T, request: IncomingMessage) => void
  - - (client: T, request: IncomingMessage): void
    - Parameters
      - client: T
      - request: IncomingMessage
      Returns void
Returns Server<T>
Overrides EventEmitter.addListener
- Defined in node_modules/vite/dist/node/index.d.ts:1379
Parameters
- event: "error"
- cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Server<T>
Overrides EventEmitter.addListener
- Defined in node_modules/vite/dist/node/index.d.ts:1380
Parameters
- event: "headers"
- cb: (headers: string[], request: IncomingMessage) => void
  - - (headers: string[], request: IncomingMessage): void
    - Parameters
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns Server<T>
Overrides EventEmitter.addListener
- Defined in node_modules/vite/dist/node/index.d.ts:1384
Parameters
- event: "close" | "listening"
- cb: () => void
  - - (): void
    - Returns void
Returns Server<T>
Overrides EventEmitter.addListener
- Defined in node_modules/vite/dist/node/index.d.ts:1385
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Server<T>

address

address(): string | WebSocket.AddressInfo

- Defined in node_modules/vite/dist/node/index.d.ts:1307
Returns string | WebSocket.AddressInfo

close

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

- Defined in node_modules/vite/dist/node/index.d.ts:1308
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: T, request: IncomingMessage) => void): void

- Defined in node_modules/vite/dist/node/index.d.ts:1309
Parameters
- request: IncomingMessage
- socket: Duplex
- upgradeHead: Buffer
- callback: (client: T, request: IncomingMessage) => void
  - - (client: T, request: IncomingMessage): void
    - Parameters
      - client: T
      - request: IncomingMessage
      Returns void
Returns void

off

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

Overrides EventEmitter.off
- Defined in node_modules/vite/dist/node/index.d.ts:1356
Parameters
- event: "connection"
- cb: (this: Server<T>, socket: T, request: IncomingMessage) => void
  - - (this: Server<T>, socket: T, request: IncomingMessage): void
    - Parameters
      - this: Server<T>
      - socket: T
      - request: IncomingMessage
      Returns void
Returns Server<T>
Overrides EventEmitter.off
- Defined in node_modules/vite/dist/node/index.d.ts:1360
Parameters
- event: "error"
- cb: (this: Server<T>, error: Error) => void
  - - (this: Server<T>, error: Error): void
    - Parameters
      - this: Server<T>
      - error: Error
      Returns void
Returns Server<T>
Overrides EventEmitter.off
- Defined in node_modules/vite/dist/node/index.d.ts:1361
Parameters
- event: "headers"
- cb: (this: Server<T>, headers: string[], request: IncomingMessage) => void
  - - (this: Server<T>, headers: string[], request: IncomingMessage): void
    - Parameters
      - this: Server<T>
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns Server<T>
Overrides EventEmitter.off
- Defined in node_modules/vite/dist/node/index.d.ts:1369
Parameters
- event: "close" | "listening"
- cb: (this: Server<T>) => void
  - - (this: Server<T>): void
    - Parameters
      - this: Server<T>
      Returns void
Returns Server<T>
Overrides EventEmitter.off
- Defined in node_modules/vite/dist/node/index.d.ts:1370
Parameters
- event: string | symbol
- listener: (this: Server<T>, ...args: any[]) => void
  - - (this: Server<T>, ...args: any[]): void
    - Parameters
      - this: Server<T>
      - Rest ...args: any[]
      Returns void
Returns Server<T>

on

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

Overrides EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:1318
Parameters
- event: "connection"
- cb: (this: Server<T>, socket: T, request: IncomingMessage) => void
  - - (this: Server<T>, socket: T, request: IncomingMessage): void
    - Parameters
      - this: Server<T>
      - socket: T
      - request: IncomingMessage
      Returns void
Returns Server<T>
Overrides EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:1322
Parameters
- event: "error"
- cb: (this: Server<T>, error: Error) => void
  - - (this: Server<T>, error: Error): void
    - Parameters
      - this: Server<T>
      - error: Error
      Returns void
Returns Server<T>
Overrides EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:1323
Parameters
- event: "headers"
- cb: (this: Server<T>, headers: string[], request: IncomingMessage) => void
  - - (this: Server<T>, headers: string[], request: IncomingMessage): void
    - Parameters
      - this: Server<T>
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns Server<T>
Overrides EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:1331
Parameters
- event: "close" | "listening"
- cb: (this: Server<T>) => void
  - - (this: Server<T>): void
    - Parameters
      - this: Server<T>
      Returns void
Returns Server<T>
Overrides EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:1332
Parameters
- event: string | symbol
- listener: (this: Server<T>, ...args: any[]) => void
  - - (this: Server<T>, ...args: any[]): void
    - Parameters
      - this: Server<T>
      - Rest ...args: any[]
      Returns void
Returns Server<T>

once

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

Overrides EventEmitter.once
- Defined in node_modules/vite/dist/node/index.d.ts:1337
Parameters
- event: "connection"
- cb: (this: Server<T>, socket: T, request: IncomingMessage) => void
  - - (this: Server<T>, socket: T, request: IncomingMessage): void
    - Parameters
      - this: Server<T>
      - socket: T
      - request: IncomingMessage
      Returns void
Returns Server<T>
Overrides EventEmitter.once
- Defined in node_modules/vite/dist/node/index.d.ts:1341
Parameters
- event: "error"
- cb: (this: Server<T>, error: Error) => void
  - - (this: Server<T>, error: Error): void
    - Parameters
      - this: Server<T>
      - error: Error
      Returns void
Returns Server<T>
Overrides EventEmitter.once
- Defined in node_modules/vite/dist/node/index.d.ts:1342
Parameters
- event: "headers"
- cb: (this: Server<T>, headers: string[], request: IncomingMessage) => void
  - - (this: Server<T>, headers: string[], request: IncomingMessage): void
    - Parameters
      - this: Server<T>
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns Server<T>
Overrides EventEmitter.once
- Defined in node_modules/vite/dist/node/index.d.ts:1350
Parameters
- event: "close" | "listening"
- cb: (this: Server<T>) => void
  - - (this: Server<T>): void
    - Parameters
      - this: Server<T>
      Returns void
Returns Server<T>
Overrides EventEmitter.once
- Defined in node_modules/vite/dist/node/index.d.ts:1351
Parameters
- event: string | symbol
- listener: (this: Server<T>, ...args: any[]) => void
  - - (this: Server<T>, ...args: any[]): void
    - Parameters
      - this: Server<T>
      - Rest ...args: any[]
      Returns void
Returns Server<T>

removeListener

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

Overrides EventEmitter.removeListener
- Defined in node_modules/vite/dist/node/index.d.ts:1390
Parameters
- event: "connection"
- cb: (client: T) => void
  - - (client: T): void
    - Parameters
      - client: T
      Returns void
Returns Server<T>
Overrides EventEmitter.removeListener
- Defined in node_modules/vite/dist/node/index.d.ts:1391
Parameters
- event: "error"
- cb: (err: Error) => void
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns Server<T>
Overrides EventEmitter.removeListener
- Defined in node_modules/vite/dist/node/index.d.ts:1392
Parameters
- event: "headers"
- cb: (headers: string[], request: IncomingMessage) => void
  - - (headers: string[], request: IncomingMessage): void
    - Parameters
      - headers: string[]
      - request: IncomingMessage
      Returns void
Returns Server<T>
Overrides EventEmitter.removeListener
- Defined in node_modules/vite/dist/node/index.d.ts:1396
Parameters
- event: "close" | "listening"
- cb: () => void
  - - (): void
    - Returns void
Returns Server<T>
Overrides EventEmitter.removeListener
- Defined in node_modules/vite/dist/node/index.d.ts:1397
Parameters
- event: string | symbol
- listener: (...args: any[]) => void
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns Server<T>

shouldHandle

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

- Defined in node_modules/vite/dist/node/index.d.ts:1315
Parameters
- request: IncomingMessage
Returns boolean | Promise<boolean>

Type parameters

T: WebSocket = WebSocket

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type parameters

T: WebSocket<T> = WebSocket

Parameters

Optional options: WebSocket.ServerOptions

Optional callback: () => void

Returns void

Returns Server<T>

Properties

clients

options

path

Methods

addListener

Parameters

event: "connection"

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

Parameters

client: T

request: IncomingMessage

Returns void

Returns Server<T>

Parameters

event: "error"

cb: (err: Error) => void

Parameters

err: Error

Returns void

Returns Server<T>

Parameters

event: "headers"

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

Parameters

headers: string[]

request: IncomingMessage

Returns void

Returns Server<T>

Parameters

event: "close" | "listening"

cb: () => void

Returns void

Returns Server<T>

Parameters

event: string | symbol

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

Parameters

Rest ...args: any[]

Returns void

Returns Server<T>

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: T, request: IncomingMessage) => void

Parameters

client: T

request: IncomingMessage

Returns void

Returns void

off

Parameters

event: "connection"