Skip to main content

statusCheckHandler()

Home > @backstage/backend-common > statusCheckHandler

Express middleware for status checks.

This is commonly used to implement healthcheck and readiness routes.

Signature:

function statusCheckHandler(options?: StatusCheckHandlerOptions): Promise<RequestHandler>;

Parameters

ParameterTypeDescription
optionsStatusCheckHandlerOptions(Optional) An optional configuration object.

Returns:

Promise<RequestHandler>

An Express error request handler