default

default(options?): object

Defined in: router.js:62

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.

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.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

_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

send?

object

Returns

Function

delete()

delete(path, pipeline, routeOpts?): { _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 13 more …; delete(path: string, pipeline: Function | … 1 more … | RouteConfig, routeOpts?: object | undefined): …; }

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 (only for function/array pipelines)

Returns

{ _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 13 more …; delete(path: string, pipeline: Function | … 1 more … | RouteConfig, routeOpts?: object | undefined): …; }

get()

get(path, pipeline, routeOpts?): { _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 13 more …; delete(path: string, pipeline: Function | … 1 more … | RouteConfig, routeOpts?: object | undefined): …; }

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 (only for function/array pipelines)

Returns

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[]; … 13 more …; delete(path: string, pipeline: Function | … 1 more … | RouteConfig, routeOpts?: object | undefined): …; }

Mount a sub-router at a prefix path.

Parameters

prefix

string

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

subRouter

object

Another router instance

Returns

patch()

patch(path, pipeline, routeOpts?): { _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 13 more …; delete(path: string, pipeline: Function | … 1 more … | RouteConfig, routeOpts?: object | undefined): …; }

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 (only for function/array pipelines)

Returns

post()

post(path, pipeline, routeOpts?): { _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 13 more …; delete(path: string, pipeline: Function | … 1 more … | RouteConfig, routeOpts?: object | undefined): …; }

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 (only for function/array pipelines)

Returns

put()

put(path, pipeline, routeOpts?): { _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 13 more …; delete(path: string, pipeline: Function | … 1 more … | RouteConfig, routeOpts?: object | undefined): …; }

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 (only for function/array pipelines)

Returns

use()

use(…fns): { _dispatcher: Instance<HTTPVersion.V1>; _pathIndex: Instance<HTTPVersion.V1>; _registry: MethodRegistry; _middleware: any[]; … 13 more …; delete(path: string, pipeline: Function | … 1 more … | RouteConfig, routeOpts?: object | undefined): …; }

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

Parameters

fns

…Function[]

Middleware functions