Server | Electron Forge

Hierarchy

EventEmitter
- Server

Index

Constructors

constructor

Methods

Constructors

constructor

new Server(options?: ServerOptions): Server

Overrides events.EventEmitter.constructor
- Defined in node_modules/vite/dist/node/index.d.ts:394
Creates the proxy server with specified options.

Parameters
- Optional options: ServerOptions
  
  Config object passed to the proxy
Returns Server

Methods

addListener

addListener(event: string, listener: () => void): Server

Overrides events.EventEmitter.addListener
- Defined in node_modules/vite/dist/node/index.d.ts:456
Parameters
- event: string
- listener: () => void
  - - (): void
    - Returns void
Returns Server

close

close(callback?: () => void): void

- Defined in node_modules/vite/dist/node/index.d.ts:433
A function that closes the inner webserver and stops listening on given port

Parameters
- Optional callback: () => void
  - - (): void
    - Returns void
Returns void

emit

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

Overrides events.EventEmitter.emit
- Defined in node_modules/vite/dist/node/index.d.ts:526
Parameters
- event: string
- Rest ...args: any[]
Returns boolean

getMaxListeners

getMaxListeners(): number

Overrides events.EventEmitter.getMaxListeners
- Defined in node_modules/vite/dist/node/index.d.ts:523
Returns number

listen

listen(port: number): Server

- Defined in node_modules/vite/dist/node/index.d.ts:428
A function that wraps the object in a webserver, for your convenience

Parameters
- port: number
  
  Port to listen on
Returns Server

listenerCount

listenerCount(type: string): number

Overrides events.EventEmitter.listenerCount
- Defined in node_modules/vite/dist/node/index.d.ts:527
Parameters
- type: string
Returns number

listeners

listeners(event: string): (() => void)[]

Overrides events.EventEmitter.listeners
- Defined in node_modules/vite/dist/node/index.d.ts:525
Parameters
- event: string
Returns (() => void)[]

on

on(event: string, listener: () => void): Server
on(event: "error", listener: ErrorCallback): Server
on(event: "start", listener: (req: IncomingMessage, res: ServerResponse<IncomingMessage>, target: ProxyTargetUrl) => void): Server
on(event: "proxyReq", listener: (proxyReq: ClientRequest, req: IncomingMessage, res: ServerResponse<IncomingMessage>, options: ServerOptions) => void): Server
on(event: "proxyRes", listener: (proxyRes: IncomingMessage, req: IncomingMessage, res: ServerResponse<IncomingMessage>) => void): Server
on(event: "proxyReqWs", listener: (proxyReq: ClientRequest, req: IncomingMessage, socket: Socket, options: ServerOptions, head: any) => void): Server
on(event: "econnreset", listener: (err: Error, req: IncomingMessage, res: ServerResponse<IncomingMessage>, target: ProxyTargetUrl) => void): Server
on(event: "end", listener: (req: IncomingMessage, res: ServerResponse<IncomingMessage>, proxyRes: IncomingMessage) => void): Server
on(event: "close", listener: (proxyRes: IncomingMessage, proxySocket: Socket, proxyHead: any) => void): Server

Overrides events.EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:457
Parameters
- event: string
- listener: () => void
  - - (): void
    - Returns void
Returns Server
Overrides events.EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:458
Parameters
- event: "error"
- listener: ErrorCallback
Returns Server
Overrides events.EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:459
Parameters
- event: "start"
- listener: (req: IncomingMessage, res: ServerResponse<IncomingMessage>, target: ProxyTargetUrl) => void
  - - (req: IncomingMessage, res: ServerResponse<IncomingMessage>, target: ProxyTargetUrl): void
    - Parameters
      - req: IncomingMessage
      - res: ServerResponse<IncomingMessage>
      - target: ProxyTargetUrl
      Returns void
Returns Server
Overrides events.EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:467
Parameters
- event: "proxyReq"
- listener: (proxyReq: ClientRequest, req: IncomingMessage, res: ServerResponse<IncomingMessage>, options: ServerOptions) => void
  - - (proxyReq: ClientRequest, req: IncomingMessage, res: ServerResponse<IncomingMessage>, options: ServerOptions): void
    - Parameters
      - proxyReq: ClientRequest
      - req: IncomingMessage
      - res: ServerResponse<IncomingMessage>
      - options: ServerOptions
      Returns void
Returns Server
Overrides events.EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:476
Parameters
- event: "proxyRes"
- listener: (proxyRes: IncomingMessage, req: IncomingMessage, res: ServerResponse<IncomingMessage>) => void
  - - (proxyRes: IncomingMessage, req: IncomingMessage, res: ServerResponse<IncomingMessage>): void
    - Parameters
      - proxyRes: IncomingMessage
      - req: IncomingMessage
      - res: ServerResponse<IncomingMessage>
      Returns void
Returns Server
Overrides events.EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:484
Parameters
- event: "proxyReqWs"
- listener: (proxyReq: ClientRequest, req: IncomingMessage, socket: Socket, options: ServerOptions, head: any) => void
  - - (proxyReq: ClientRequest, req: IncomingMessage, socket: Socket, options: ServerOptions, head: any): void
    - Parameters
      - proxyReq: ClientRequest
      - req: IncomingMessage
      - socket: Socket
      - options: ServerOptions
      - head: any
      Returns void
Returns Server
Overrides events.EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:494
Parameters
- event: "econnreset"
- listener: (err: Error, req: IncomingMessage, res: ServerResponse<IncomingMessage>, target: ProxyTargetUrl) => void
  - - (err: Error, req: IncomingMessage, res: ServerResponse<IncomingMessage>, target: ProxyTargetUrl): void
    - Parameters
      - err: Error
      - req: IncomingMessage
      - res: ServerResponse<IncomingMessage>
      - target: ProxyTargetUrl
      Returns void
Returns Server
Overrides events.EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:503
Parameters
- event: "end"
- listener: (req: IncomingMessage, res: ServerResponse<IncomingMessage>, proxyRes: IncomingMessage) => void
  - - (req: IncomingMessage, res: ServerResponse<IncomingMessage>, proxyRes: IncomingMessage): void
    - Parameters
      - req: IncomingMessage
      - res: ServerResponse<IncomingMessage>
      - proxyRes: IncomingMessage
      Returns void
Returns Server
Overrides events.EventEmitter.on
- Defined in node_modules/vite/dist/node/index.d.ts:511
Parameters
- event: "close"
- listener: (proxyRes: IncomingMessage, proxySocket: Socket, proxyHead: any) => void
  - - (proxyRes: IncomingMessage, proxySocket: Socket, proxyHead: any): void
    - Parameters
      - proxyRes: IncomingMessage
      - proxySocket: Socket
      - proxyHead: any
      Returns void
Returns Server

once

once(event: string, listener: () => void): Server

Overrides events.EventEmitter.once
- Defined in node_modules/vite/dist/node/index.d.ts:520
Parameters
- event: string
- listener: () => void
  - - (): void
    - Returns void
Returns Server

removeAllListeners

removeAllListeners(event?: string): Server

Overrides events.EventEmitter.removeAllListeners
- Defined in node_modules/vite/dist/node/index.d.ts:522
Parameters
- Optional event: string
Returns Server

removeListener

removeListener(event: string, listener: () => void): Server

Overrides events.EventEmitter.removeListener
- Defined in node_modules/vite/dist/node/index.d.ts:521
Parameters
- event: string
- listener: () => void
  - - (): void
    - Returns void
Returns Server

setMaxListeners

setMaxListeners(n: number): Server

Overrides events.EventEmitter.setMaxListeners
- Defined in node_modules/vite/dist/node/index.d.ts:524
Parameters
- n: number
Returns Server

web

web(req: IncomingMessage, res: ServerResponse<IncomingMessage>, options?: ServerOptions, callback?: ErrorCallback): void

- Defined in node_modules/vite/dist/node/index.d.ts:402
Used for proxying regular HTTP(S) requests

Parameters
- req: IncomingMessage
  
  Client request.
- res: ServerResponse<IncomingMessage>
  
  Client response.
- Optional options: ServerOptions
  
  Additional options.
- Optional callback: ErrorCallback
Returns void

ws

ws(req: IncomingMessage, socket: unknown, head: unknown, options?: ServerOptions, callback?: ErrorCallback): void

- Defined in node_modules/vite/dist/node/index.d.ts:416
Used for proxying regular HTTP(S) requests

Parameters
- req: IncomingMessage
  
  Client request.
- socket: unknown
  
  Client socket.
- head: unknown
  
  Client head.
- Optional options: ServerOptions
  
  Additional options.
- Optional callback: ErrorCallback
Returns void

Static createProxy

createProxy(options?: ServerOptions): Server

- Defined in node_modules/vite/dist/node/index.d.ts:454
Creates the proxy server with specified options.

Parameters
- Optional options: ServerOptions
  
  Config object passed to the proxy
Returns Server
Proxy object with handlers for ws and web requests

Static createProxyServer

createProxyServer(options?: ServerOptions): Server

- Defined in node_modules/vite/dist/node/index.d.ts:440
Creates the proxy server with specified options.

Parameters
- Optional options: ServerOptions
  
  Config object passed to the proxy
Returns Server
Proxy object with handlers for ws and web requests

Static createServer

createServer(options?: ServerOptions): Server

- Defined in node_modules/vite/dist/node/index.d.ts:447
Creates the proxy server with specified options.

Parameters
- Optional options: ServerOptions
  
  Config object passed to the proxy
Returns Server
Proxy object with handlers for ws and web requests

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional options: ServerOptions

Returns Server

Methods

addListener

Parameters

event: string

listener: () => void

Returns void

Returns Server

close

Parameters

Optional callback: () => void

Returns void

Returns void

emit

Parameters

event: string

Rest ...args: any[]

Returns boolean

getMaxListeners

Returns number

listen

Parameters

port: number

Returns Server

listenerCount

Parameters

type: string

Returns number

listeners

Parameters

event: string

Returns (() => void)[]

on

Parameters

event: string

listener: () => void

Returns void

Returns Server

Parameters

event: "error"

listener: ErrorCallback

Returns Server

Parameters

event: "start"

listener: (req: IncomingMessage, res: ServerResponse<IncomingMessage>, target: ProxyTargetUrl) => void

Parameters

req: IncomingMessage

res: ServerResponse<IncomingMessage>

target: ProxyTargetUrl

Returns void

Returns Server

Parameters

event: "proxyReq"

listener: (proxyReq: ClientRequest, req: IncomingMessage, res: ServerResponse<IncomingMessage>, options: ServerOptions) => void

Parameters

proxyReq: ClientRequest

req: IncomingMessage

res: ServerResponse<IncomingMessage>

options: ServerOptions

Returns void

Returns Server

Parameters

event: "proxyRes"

listener: (proxyRes: IncomingMessage, req: IncomingMessage, res: ServerResponse<IncomingMessage>) => void

Parameters

proxyRes: IncomingMessage

req: IncomingMessage

res: ServerResponse<IncomingMessage>

Returns void

Returns Server

Parameters

event: "proxyReqWs"