Interface ServiceHealthEndpointOptions

Options used to set up service health endpoint.

interface ServiceHealthEndpointOptions {
defaultHealth?: Record<string, unknown>;
healthRoute?: string;
}

defaultHealth?: Record<string, unknown>

defaultHealth: A key-value pair object describing the default health of the service. If not specified, will default to an empty object {}.

healthRoute?: string

healthRoute: the path to mount the service health endpoint. If not specified, will default to /health.

Properties