lib/web/index.ts - qunitx-cli documentation

Classes

c

Minimal HTTP + WebSocket server used to serve test bundles and push reload events.

_server: http.Server
Underlying Node.js HTTP server instance.
close(): Promise<void>
Closes the underlying HTTP server and all active connections, returning a Promise that resolves once the server is fully closed.
delete(
path: string,
handler: RouteHandler
): void
Registers a DELETE route handler.
get(
path: string,
handler: RouteHandler
): void
Registers a GET route handler.
listen(
port?: number,
callback?: () => void
): Promise<void>
Starts listening on the given port (0 = OS-assigned).
middleware: Middleware[]
Registered middleware functions, applied in order before each route handler.
post(
path: string,
handler: RouteHandler
): void
Registers a POST route handler.
publish(data: string): void
Broadcasts a message to all connected WebSocket clients.
put(
path: string,
handler: RouteHandler
): void
Registers a PUT route handler.
routes: Record<string, Record<string, Route>>
Registered routes keyed by HTTP method then path.
serve(
config?: { port: number; onListen?: (s: object) => void; onError?: (e: Error) => void; },
handler: (
req: http.IncomingMessage,
res: http.ServerResponse
) => void
): Promise<http.Server>
Creates and starts a plain http.createServer instance on the given port.
use(middleware: Middleware): void
Adds a middleware function to the chain.
wss: WebSocketServer
WebSocket server attached to the HTTP server for live-reload broadcasts.

I

The request a route handler receives: node's, plus the four conveniences this server attaches before dispatching.

params: Record<string, string>
Values captured by the matched route's :name segments; {} for a literal route.
path: string
The URL's pathname, without the query string.
query: Record<string, string>
The parsed query string.
send: (data: string) => void
Responds with data as text/plain and ends the response.

I

The response a route handler receives: node's, plus a JSON shorthand.

json: (data: unknown) => void
Responds with data as application/json and ends the response.

I

One registered route: the parsed shape get()/post()/… store and #findRouteHandler matches against.

compiledRegex: RegExp | null
Prebuilt matcher for parameterised paths; null for static ones.
handler: RouteHandler
The handler #handleRequest dispatches to when this route matches.
isWildcard: boolean
Whether this is the catch-all /* route.
paramNames: string[]
Names of the :param segments, in order of appearance.
paramValues: string[]
The captured segment values from the most recent match; feeds req.params.
path: string
The registered path pattern, e.g. /tests/:id or the /* wildcard.