ExpressBackend
Ce contenu n’est pas encore disponible dans votre langue.
Defined in: src/http/backend/ExpressBackend.ts:124
Express-backed HTTP backend — drop-in alternative to the Fastify default. Intended for teams that already have an Express-based plugin ecosystem (session stores, auth, observability) they want to reuse.
express is an optional peer dependency: install it only if you use
this backend. When no app is injected, the backend imports express
dynamically and builds a fresh one.
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ExpressBackend(
options?):ExpressBackend
Defined in: src/http/backend/ExpressBackend.ts:138
Parameters
Section titled “Parameters”options?
Section titled “options?”Returns
Section titled “Returns”ExpressBackend
Properties
Section titled “Properties”
readonlyname:"express"='express'
Defined in: src/http/backend/ExpressBackend.ts:125
Implementation of
Section titled “Implementation of”Methods
Section titled “Methods”getApp()
Section titled “getApp()”getApp():
ExpressAppLike
Defined in: src/http/backend/ExpressBackend.ts:147
Inject / access the underlying Express app — useful for native middleware.
Returns
Section titled “Returns”ExpressAppLike
listen()
Section titled “listen()”listen(
host,port):Promise<ServerBinding>
Defined in: src/http/backend/ExpressBackend.ts:175
Start listening. Returns a ServerBinding with the actual bound port.
Parameters
Section titled “Parameters”string
number
Returns
Section titled “Returns”Promise<ServerBinding>
Implementation of
Section titled “Implementation of”registerRoute()
Section titled “registerRoute()”registerRoute(
route):void
Defined in: src/http/backend/ExpressBackend.ts:152
Register all routes before listen is called. Duplicate paths must be rejected.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”HttpServerBackend.registerRoute
registerWebSocket()
Section titled “registerWebSocket()”registerWebSocket(
reg):void
Defined in: src/http/backend/ExpressBackend.ts:156
Optional capability: register a WebSocket endpoint. Backends that
implement this support websocket() routes; absence is detected by
HttpExtension.bind and reported as a clear error.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”HttpServerBackend.registerWebSocket
setDefaultResponseHeaders()
Section titled “setDefaultResponseHeaders()”setDefaultResponseHeaders(
headers):void
Defined in: src/http/backend/ExpressBackend.ts:171
Optional: replace the header map the backend writes ahead of every response it emits — including the error, not-found and upgrade-reject responses no middleware ever sees. A response’s own header must still win, so these are written first and overwritten, not merged over.
HttpExtension wires withSecurityHeaders(...) here and passes {}
for the opt-out. It is only called when that was configured: a backend
comes with its own default (DEFAULT_RESPONSE_SECURITY_HEADERS
for the shipped ones), so an untouched builder must not overwrite it.
Parameters
Section titled “Parameters”headers
Section titled “headers”Readonly<Record<string, string>>
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”HttpServerBackend.setDefaultResponseHeaders
setErrorHandler()
Section titled “setErrorHandler()”setErrorHandler(
handler):void
Defined in: src/http/backend/ExpressBackend.ts:167
Optional: register a last-resort error handler. It MUST see both
errors thrown by route handlers AND backend-internal errors (body
parsing, etc.); if it throws, the backend falls back to its default
error mapping. HttpExtension wires withErrorHandler here.
Parameters
Section titled “Parameters”handler
Section titled “handler”(err, request) => HttpResponse | Promise<HttpResponse>
Returns
Section titled “Returns”void
Implementation of
Section titled “Implementation of”HttpServerBackend.setErrorHandler
setNotFound()
Section titled “setNotFound()”setNotFound(
handler):void
Defined in: src/http/backend/ExpressBackend.ts:163
Optional: register a method-agnostic not-found handler, invoked for
any request that matched no route (including unmatched OPTIONS/HEAD).
HttpExtension wires fallback() here. If the handler throws, the
backend applies its default error mapping.
Parameters
Section titled “Parameters”handler
Section titled “handler”(request) => HttpResponse | Promise<HttpResponse>
Returns
Section titled “Returns”void