A higher-level HTTP app/router layer built on top of HttpServer.
Use App.get, App.post, middleware, groups, and mounts to build simple request routing without dropping to the low-level request-handler callback for every endpoint.
@eryx/http/App Module
Summary
Exported Class
_routes: { Route }
_mounts: { Mount }
App:_execute(request: HttpServer.ServerRequest, response: ServerResponse.ServerResponse, pathname: string, sharedState: { [string]: any }, mountPath: string?) → (AppContext, { any })
App:listen(callback: (((host: string, port: number) → ()))?, options: HttpServer.HttpServerOptions?) → ()
Functions
AppContextMethods:form() → QueryTable?
API Reference
Exported Class
App
Implements: AppFields
Properties
_routes: { Route }
_mounts: { Mount }
App:route
Registers a route handler for a method/path pair.
Parameters
HTTP method such as "GET" or "POST".
Route pattern beginning with /. Supports :param and trailing *splat.
Request handler for matching requests.
Optional route metadata such as a route name or route-local middleware.
Returns
Self, for chaining.
App:use
Registers middleware that wraps every route and mounted child app.
Parameters
Middleware callback receiving (ctx, next).
Returns
App
App:useSessions
Registers server-side session middleware and exposes ctx.session.
Parameters
Session middleware options.
Returns
App
App:error
Registers a handler for framework-generated status responses such as 404 or 405.
Parameters
HTTP status code to intercept.
Handler that returns the replacement response.
Returns
App
App:onError
Registers a catch-all exception handler for uncaught route or middleware errors.
Parameters
Recovery handler receiving (ctx, err).
Returns
App
App:mount
Mounts another app or router under a URL prefix.
Parent middleware runs before child middleware, and child routes see
ctx.mountPath / ctx.pathWithinMount.
Parameters
Returns
App
App:group
Creates and mounts a child router under a prefix, then optionally configures it.
Parameters
URL prefix such as "/api".
Optional callback invoked with the new child router.
Returns
The new child router.
App:urlFor
Builds a URL for a named route.
App:urlFor(name: string, params: { [string]: any }?, query: { [string]: string | number | boolean | { string | number | boolean } }?) → string
Parameters
Route name registered through options.name.
Returns
The generated relative URL.
App:static
Mounts a static directory under a URL prefix.
Files are served for GET/HEAD requests only. Requests that attempt
path traversal are rejected. When fallthrough is true, missing files
continue to later routes instead of immediately returning 404.
Parameters
URL prefix such as "/assets".
Filesystem directory to expose.
Static file options.
Returns
App
App:get
Registers a GET route.
Parameters
Route pattern beginning with /.
Handler for matching requests.
Optional route metadata.
Returns
App
App:post
Registers a POST route.
Parameters
Route pattern beginning with /.
Handler for matching requests.
Optional route metadata.
Returns
App
App:put
Registers a PUT route.
Parameters
Route pattern beginning with /.
Handler for matching requests.
Optional route metadata.
Returns
App
App:delete
Registers a DELETE route.
Parameters
Route pattern beginning with /.
Handler for matching requests.
Optional route metadata.
Returns
App
App:patch
Registers a PATCH route.
Parameters
Route pattern beginning with /.
Handler for matching requests.
Optional route metadata.
Returns
App
App:head
Registers a HEAD route.
Parameters
Route pattern beginning with /.
Handler for matching requests.
Optional route metadata.
Returns
App
App:options
Registers an OPTIONS route.
Parameters
Route pattern beginning with /.
Handler for matching requests.
Optional route metadata.
Returns
App
App:any
Registers a route that matches any method.
Parameters
Route pattern beginning with /.
Handler for matching requests.
Optional route metadata.
Returns
App
App:websocket
Registers a WebSocket endpoint.
Parameters
Route pattern beginning with /.
Handler receiving (ctx, ws) after a successful upgrade.
Optional route metadata.
Returns
App
App:_match
App:_execute
App:_execute(request: HttpServer.ServerRequest, response: ServerResponse.ServerResponse, pathname: string, sharedState: { [string]: any }, mountPath: string?) → (AppContext, { any })
App:_handle
App:handler
Returns a low-level HttpServer-compatible handler for this app.
Returns
(HttpServer.ServerRequest, ServerResponse.ServerResponse) -> ()
App:createServer
Creates a low-level HttpServer that dispatches through this app.
Parameters
Optional server options overriding app defaults.
Returns
HttpServer.HttpServer
HttpServer
App:listen
Starts listening with this app's handler.
This is a convenience wrapper around App.createServer followed by HttpServer.listen.
App:listen(callback: (((host: string, port: number) → ()))?, options: HttpServer.HttpServerOptions?) → ()
Parameters
Optional listener-ready callback receiving (host, port).
Optional server options overriding app defaults.
App:close
Closes the underlying server if this app is currently listening.
App:close() → ()
Functions
AppContextMethods:json
AppContextMethods:form
AppContextMethods:form() → QueryTable?
AppContextMethods:multipart
AppContextMethods:cookie
Returns the first parsed request cookie value for the given cookie name.
Parameters
Cookie name.
Returns
string?
AppContextMethods:send
AppContextMethods:text
AppContextMethods:html
AppContextMethods:jsonResponse
AppContextMethods:redirect
AppContextMethods:setCookie
Appends a Set-Cookie response header.
Parameters
AppContextMethods:clearCookie
Clears a cookie by setting it to an empty value with an expired timestamp.
Parameters
Cookie name.
Cookie attributes such as path or domain to target the existing cookie.
AppContextMethods:sendFile
Streams a file as the HTTP response body.
Parameters
Filesystem path to the file.
Optional response overrides.
Types
ResponseSpec
headers: Headers?
RouteOptions
Optional metadata for route registration helpers like App.get.
Route-local middleware that runs inside app/group middleware but before the handler.
WebSocket upgrade options, used by App.websocket.
SendFileOptions
Options for AppContext.sendFile.
type SendFileOptions = {
contentType: string?,
filename: string?,
headers: Headers?,
status: number?
}
headers: Headers?
CookieOptions
Options for setting response cookies from the app layer.
sameSite: "Strict" | "Lax" | "None"?
AppContext
type AppContext = {
app: App,
request: HttpServer.ServerRequest,
response: ServerResponse.ServerResponse,
params: Params,
query: QueryTable,
cookies: { [string]: string | { string } },
session: any?,
state: { [string]: any },
route: { method: string, path: string }?,
mountPath: string?,
pathWithinMount: string,
originalPath: string,
errorStatus: number?,
errorData: { [string]: any }?,
json: ((self: AppContext) → any),
form: ((self: AppContext) → QueryTable?),
multipart: ((self: AppContext) → { any }?),
cookie: ((self: AppContext, name: string) → string?),
send: (
self: AppContext,
status: number,
body: string?,
headers: Headers?
) → (),
text: (
self: AppContext,
body: string,
status: number?,
headers: Headers?
) → (),
html: (
self: AppContext,
body: string,
status: number?,
headers: Headers?
) → (),
jsonResponse: (
self: AppContext,
data: any,
status: number?,
headers: Headers?
) → (),
redirect: (
self: AppContext,
location: string,
status: number?,
headers: Headers?
) → (),
setCookie: (
self: AppContext,
name: string,
value: string,
options: CookieOptions?
) → (),
clearCookie: ((self: AppContext, name: string, options: CookieOptions?) → ()),
sendFile: ((self: AppContext, path: string, options: SendFileOptions?) → ())
}
AppContext:form() → QueryTable?
Appends a Set-Cookie response header.
Clears a cookie with an expired Set-Cookie response header.
Streams a file as the response body.
params: Params
query: QueryTable