🚨 Announcing Vendure v2 Beta

WorkerHealthCheckConfig

WorkerHealthCheckConfig

Package: @vendure/core File: worker-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;
}

Members

port

property
type:
number
The port on which the worker will listen

hostname

property
type:
string
default:
'localhost'
The hostname

route

property
type:
string
default:
'/health'
The route at which the health check is available.