Skip to main content

SystemOptions

SystemOptions​

@vendure/corevendure-config.ts
v1.6.0

Options relating to system functions.

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

healthChecks​

property
v1.6.0
HealthCheckStrategy[]
default:
[TypeORMHealthCheckStrategy]

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
ErrorHandlerStrategy[]
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.

cacheStrategy​

property
v3.1.0
CacheStrategy
default:
InMemoryCacheStrategy

Defines the underlying method used to store cache key-value pairs which powers the CacheService.