default

default(options?): object

Defined in: router.js:84

Create a new Ergo router instance.

Parameters

options?

catchHandler?

Function

Default catch handler for all route pipelines

debug?

boolean

Enable pipeline debug tracing. When true, responseAcc._trace is initialized per request with {steps, breakAt}.

defaults?

object

Default middleware config for declarative routes. Each key corresponds to a pipeline stage (e.g. accepts, cookie, timeout). Route-level config overrides these. Set a key to false to disable by default.

onResponse?

Function

Router-level observation hook. Fires on every response: both pipeline-routed responses (after send()) and transport-level short-circuits (404, 405, 415, 429, OPTIONS, CORS preflight). For pipeline responses, route-level hooks fire first, then the router-level hook. Receives (req, res, responseInfo, domainAcc) where domainAcc is undefined for transport-level responses (no pipeline ran). responseInfo.source is 'pipeline' or 'transport'. Hook errors are swallowed.

redactHeaders?

Set<string>

Header names to replace with '[REDACTED]' in responseInfo.headers passed to onResponse hooks. Defaults to DEFAULT_REDACTED_HEADERS (authorization, proxy-authorization, cookie, set-cookie). Pass an empty Set to disable redaction. Route-level redactHeaders overrides this.

send?

object

Default send() options applied to all routes

strict?

boolean

If true, throw on unknown config keys; if false, warn

strictBody?

boolean

Enforce Content-Type on POST/PUT requests

strictPatch?

boolean

Enforce Content-Type on PATCH requests

timing?

boolean | object

Inject an X-Response-Time header measuring pipeline execution time. Pass true for defaults (x-response-time, 3 decimal places), or {header?: string, precision?: number} for custom configuration. Zero overhead when disabled.

transport?

object

Transport-layer config (requestId, security, rateLimit, cors)

Returns

_dispatcher

_dispatcher: Instance<V1> = dispatcher

_middleware

_middleware: any[] = appMiddleware

_options

_options: object = options

_options.catchHandler?

optional catchHandler?: Function

_options.debug?

optional debug?: boolean

_options.defaults?

optional defaults?: object

_options.onResponse?

optional onResponse?: Function

_options.redactHeaders?

optional redactHeaders?: Set<string>

_options.send?

optional send?: object

_options.strict?

optional strict?: boolean

_options.strictBody?

optional strictBody?: boolean

_options.strictPatch?

optional strictPatch?: boolean

_options.timing?

optional timing?: boolean | object

_options.transport?

optional transport?: object

_pathIndex

_pathIndex: Instance<V1> = pathIndex

_redactSet

_redactSet: Set<string> = redactSet

_registry

_registry: MethodRegistry = registry

_routes

_routes: object[] = routes

_subRouters

_subRouters: any[] = subRouters

_transport

_transport: { run: { requestId: string | undefined; stop: boolean; }; } | undefined = transport

Union Members

Type Literal

{ run: { requestId: string | undefined; stop: boolean; }; }

run()

run(req, res, allowedMethods?): object

Run the transport layer on a request.

Parameters

req

object

HTTP request

res

object

HTTP response

allowedMethods?

Set<string>

Registered methods for this path

Returns

object

stop=true means the response has been sent (preflight, rate limited)

requestId

requestId: string | undefined

stop

stop: boolean

---

undefined

_wrap

_wrap: (pipeline, routeOpts?) => Function = wrapPipeline

Parameters

pipeline

Function | Function[]

routeOpts?

catchHandler?

Function

noSend?

boolean

onResponse?

Function

redactHeaders?

Set<string>

send?

object

Returns

Function

delete()

delete(path, pipeline, routeOpts?): { _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }

Register a DELETE route.

Parameters

path

string

URL pattern (e.g. ‘/users/:id’)

pipeline

Function | Function[] | RouteConfig

Handler function, pipeline array, or declarative config object

routeOpts?

object

Per-route options (validated and merged for all pipeline types)

Returns

{ _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }

get()

get(path, pipeline, routeOpts?): { _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }

Register a GET route.

Parameters

path

string

URL pattern (e.g. ‘/users/:id’)

pipeline

Function | Function[] | RouteConfig

Handler function, pipeline array, or declarative config object

routeOpts?

object

Per-route options (validated and merged for all pipeline types)

Returns

{ _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }

handle()

handle(): (req, res) => any

Create the Node.js HTTP request handler.

Returns

(req, res) => any

listen()

listen(port, …args): Server<typeof IncomingMessage, typeof ServerResponse>

Convenience: create an HTTP server and start listening.

Parameters

port

number

args

…any[]

Additional arguments passed to server.listen()

Returns

Server<typeof IncomingMessage, typeof ServerResponse>

mount()

mount(prefix, subRouter): { _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }

Mount a sub-router at a prefix path.

Parameters

prefix

string

URL prefix (e.g. ‘/api/v1’)

subRouter

object

Another router instance

Returns

{ _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }

patch()

patch(path, pipeline, routeOpts?): { _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }

Register a PATCH route.

Parameters

path

string

URL pattern (e.g. ‘/users/:id’)

pipeline

Function | Function[] | RouteConfig

Handler function, pipeline array, or declarative config object

routeOpts?

object

Per-route options (validated and merged for all pipeline types)

Returns

{ _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }

post()

post(path, pipeline, routeOpts?): { _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }

Register a POST route.

Parameters

path

string

URL pattern (e.g. ‘/users’)

pipeline

Function | Function[] | RouteConfig

Handler function, pipeline array, or declarative config object

routeOpts?

object

Per-route options (validated and merged for all pipeline types)

Returns

{ _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }

put()

put(path, pipeline, routeOpts?): { _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }

Register a PUT route.

Parameters

path

string

URL pattern (e.g. ‘/users/:id’)

pipeline

Function | Function[] | RouteConfig

Handler function, pipeline array, or declarative config object

routeOpts?

object

Per-route options (validated and merged for all pipeline types)

Returns

{ _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }

routeTable()

routeTable(): string

Return a formatted route table string summarizing registered routes, enabled middleware, and transport configuration.

Returns

string

• Multi-line route table suitable for logging at startup

use()

use(…fns): { _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }

Add application-level middleware that runs before every route pipeline.

Parameters

fns

…Function[]

Middleware functions

Returns

{ _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 15 more …; routeTable(): string; }