Skip to main content

SystemOptions

SystemOptions

Options relating to system functions.

Signature
interface SystemOptions {
healthChecks?: HealthCheckStrategy[];
errorHandlers?: ErrorHandlerStrategy[];
}

healthChecks

property
v1.6.0
default:
[<a href='/reference/typescript-api/health-check/type-ormhealth-check-strategy#typeormhealthcheckstrategy'>TypeORMHealthCheckStrategy</a>]

Defines an array of HealthCheckStrategy instances which are used by the /health endpoint to verify that any critical systems which the Vendure server depends on are also healthy.

errorHandlers

property
v2.2.0
default:
[]

Defines an array of ErrorHandlerStrategy instances which are used to define logic to be executed when an error occurs, either on the server or the worker.