Skip to main content

Interface: HttpRouteOptions

Defined in: service-core/src/http/types.ts:121

Per-route registration options, optionally passed as the first element of a route's handler list (e.g. app.post(path, { streamingBody: true }, ...handlers)). Detected at runtime by both router implementations: a non-function first argument is treated as HttpRouteOptions rather than a RequestHandler, so omitting it entirely (the overwhelmingly common case) is unaffected — every existing call site that only ever passes handler functions keeps its exact current behavior.

Indexable​

[key: string]: any

Properties​

streamingBody?​

optional streamingBody?: boolean

Defined in: service-core/src/http/types.ts:130

When true, the router does not buffer this route's request body into req.body/req.rawBody before running its middleware/handler chain. Instead the raw body is exposed as a stream on req.bodyStream (see its doc comment on HttpRequest), and the route's own handler is responsible for consuming it and enforcing any size limit it needs — the framework's maxBodySize 413 rejection does not apply to a streaming route. Set by the @StreamingBody() route decorator; see RouteUtils.registerRoute().