Class DevServer

Development server with live-reload for Wings. Extends NodeHttp to inject WebSocket-based reload scripts into HTML responses. For file watching, use Node.js CLI flags: node --watch-path=./src boot.js This restarts the server instantly, triggering browser reload via WebSocket.

Hierarchy (view full)

NodeHttp
- DevServer

Index

Constructors

constructor

new DevServer(router, options?): DevServer
Create development server instance.
Parameters
- router: Router
  Wings router to handle requests
- Optionaloptions: ServerOptions = {}
  Server options
Returns DevServer
Throws
When router is invalid

Throws
When websocketPort is invalid
Overrides NodeHttp.constructor
- Defined in server/adapters/dev-server.js:50

Properties

`Protected`websocketConnections

websocketConnections: Set<Duplex> = ...

Set of active WebSocket connections to track for cleanup.

`Protected`websocketServer

websocketServer: Server<typeof IncomingMessage, typeof ServerResponse>

WebSocket server for live-reload.

websocketServerPort

websocketServerPort: number

WebSocket server port.

Accessors

isSSL

get isSSL(): boolean
Check if SSL/HTTPS mode is enabled.

Returns boolean
True if server is running in HTTPS mode
Inherited from NodeHttp.isSSL
- Defined in server/adapters/node-http.js:231

options

get options(): ServerOptions
Get current configuration options.

Returns ServerOptions
Configuration options
Inherited from NodeHttp.options
- Defined in server/adapters/node-http.js:222

router

get router(): Router
Get Wings router instance.

Returns Router
Wings router
Inherited from NodeHttp.router
- Defined in server/adapters/node-http.js:213

server

get server(): Server<typeof IncomingMessage, typeof ServerResponse>
Get underlying HTTP server instance.

Returns Server<typeof IncomingMessage, typeof ServerResponse>
Node.js HTTP server
Inherited from NodeHttp.server
- Defined in server/adapters/node-http.js:204

Methods

`Protected`activateWebsocketServer

activateWebsocketServer(): void
Protected
Start WebSocket server for live-reload.

Returns void
- Defined in server/adapters/dev-server.js:60

close

close(): Promise<void>
Close both HTTP and WebSocket servers.

Returns Promise<void>
Resolves when both servers are closed
Overrides NodeHttp.close
- Defined in server/adapters/dev-server.js:198

`Protected`createContext

createContext(req): Promise<Context>
Protected
Convert HTTP/HTTPS request to Wings Context.
Parameters
- req: IncomingMessage
  HTTP/HTTPS request
Returns Promise<Context>
Wings context
Inherited from NodeHttp.createContext
- Defined in server/adapters/node-http.js:102

`Protected`handleError

handleError(err, req, res): void
Protected
Handle request processing errors.
Parameters
- err: Error
  Error that occurred
- req: IncomingMessage
  Original request
- res: ServerResponse<IncomingMessage>
  Response object
Returns void
Inherited from NodeHttp.handleError
- Defined in server/adapters/node-http.js:140

injectAutoReloadScript

injectAutoReloadScript(html): string
Inject live-reload script into HTML.
Parameters
- html: string
  HTML content
Returns string
HTML with reload script
- Defined in server/adapters/dev-server.js:141

listen

listen(port, host?, callback?): Promise<void>
Start development server with live-reload.
Parameters
- port: number
  Port to listen on
- Optionalhost: string = "localhost"
  Host to bind to (default: 'localhost')
- Optionalcallback: (() => void) = ...
  Optional callback
  - - (): void
    - Returns void
Returns Promise<void>
Resolves when listening

Throws
When port is in use or invalid
Overrides NodeHttp.listen
- Defined in server/adapters/dev-server.js:178

`Protected`sendResponse

sendResponse(context, res): void
Protected
Convert Wings Context to HTTP response.
Parameters
- context: Context
  Wings context with response data
- res: ServerResponse<IncomingMessage>
  HTTP response object
Returns void
Inherited from NodeHttp.sendResponse
- Defined in server/adapters/node-http.js:121

Class DevServer

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns DevServer

Throws

Throws

Properties

ProtectedwebsocketConnections

ProtectedwebsocketServer

websocketServerPort

Accessors

isSSL

Returns boolean

options

Returns ServerOptions

router

Returns Router

server

Returns Server<typeof IncomingMessage, typeof ServerResponse>

Methods

ProtectedactivateWebsocketServer

Returns void

close

Returns Promise<void>

ProtectedcreateContext

Parameters

Returns Promise<Context>

ProtectedhandleError

Parameters

Returns void

injectAutoReloadScript

Parameters

Returns string

listen

Parameters

Returns void

Returns Promise<void>

Throws

ProtectedsendResponse

Parameters

Returns void

Settings

On This Page

`Protected`websocketConnections

`Protected`websocketServer

`Protected`activateWebsocketServer

`Protected`createContext

`Protected`handleError

`Protected`sendResponse