Class DefaultHealthCheckService

A service which can be used to check the status of HealthCheck instances registered in the application.

Hierarchy

DefaultHealthCheckService

Implements

HealthCheckService

Index

Constructors

Properties

Methods

checkHealthAsync runCheckAsync runChecksAsync

Constructors

constructor

new DefaultHealthCheckService(options): DefaultHealthCheckService
Parameters
- options: HealthCheckServiceOptions
Returns DefaultHealthCheckService
- Defined in services/DefaultHealthCheckService.ts:18

Properties

`Private` _options

_options: HealthCheckServiceOptions

Methods

checkHealthAsync

checkHealthAsync(predicate?, timeoutMilliseconds?): Promise<HealthReport>
Runs the provided health checks and returns the aggregated status.
Parameters
- Optional predicate: ((registration) => boolean)
  
  A predicate that can be used to include health checks based on user-defined criteria.
  - - (registration): boolean
    - Parameters
      
      registration: HealthCheckRegistration
      
      Returns boolean
- Optional timeoutMilliseconds: number
  
  A milliseconds which can be used to cancel the health checks.
Returns Promise<HealthReport>
A HealthReport instance.
Implementation of HealthCheckService.checkHealthAsync
- Defined in services/DefaultHealthCheckService.ts:22

`Private` runCheckAsync

runCheckAsync(registration): Promise<HealthReportEntry>
Parameters
- registration: HealthCheckRegistration
Returns Promise<HealthReportEntry>
- Defined in services/DefaultHealthCheckService.ts:58

`Private` runChecksAsync

runChecksAsync(predicate?): Promise<HealthReport>
Parameters
- Optional predicate: ((registration) => boolean)
  - - (registration): boolean
    - Parameters
      
      registration: HealthCheckRegistration
      
      Returns boolean
Returns Promise<HealthReport>
- Defined in services/DefaultHealthCheckService.ts:34

Generated using TypeDoc