Skip to main content

WorkerHealthCheckConfig

WorkerHealthCheckConfig​

@vendure/coreworker-health.service.ts
v1.2.0

Specifies the configuration for the Worker's HTTP health check endpoint.

Signature
interface WorkerHealthCheckConfig {
    port: number;
    hostname?: string;
    route?: string;
}

port​

property
number

The port on which the worker will listen

hostname​

property
string
default:
'localhost'

The hostname

route​

property
string
default:
'/health'

The route at which the health check is available.