HealthCheckStrategy

@vendure/core Source

This strategy defines health checks which, before v3.6.0, were run by the /health endpoint. Since v3.6.0 the strategies configured in systemOptions.healthChecks are not executed, and this interface will be removed in v4.0.0. See the health checks guide.

The example below shows how strategies were configured before v3.6.0.

Example

import { HttpHealthCheckStrategy, TypeORMHealthCheckStrategy } from '@vendure/core';import { MyCustomHealthCheckStrategy } from './config/custom-health-check-strategy';export const config = {  // ...  systemOptions: {    healthChecks: [      new TypeORMHealthCheckStrategy(),      new HttpHealthCheckStrategy({ key: 'my-service', url: 'https://my-service.com' }),      new MyCustomHealthCheckStrategy(),    ],  },};

HealthCheckStrategy

@vendure/core Source

The example below shows how strategies were configured before v3.6.0.

Example

import { HttpHealthCheckStrategy, TypeORMHealthCheckStrategy } from '@vendure/core';import { MyCustomHealthCheckStrategy } from './config/custom-health-check-strategy';export const config = {  // ...  systemOptions: {    healthChecks: [      new TypeORMHealthCheckStrategy(),      new HttpHealthCheckStrategy({ key: 'my-service', url: 'https://my-service.com' }),      new MyCustomHealthCheckStrategy(),    ],  },};

HealthCheckStrategy

HealthCheckStrategy

getHealthIndicator