Interface IHealthApi

register

• register(
      name: string,
      indicator: HealthIndicatorFn,
      options?: HealthIndicatorOptions,
  ): void

  Registers a health indicator.

  Parameters

  • name: string

    Indicator name, unique per application

  • indicator: HealthIndicatorFn

    Function producing the health check result

  • Optionaloptions: HealthIndicatorOptions

    Readiness membership; absent means included

  Returns void