Class HealthChecks

The HealthChecks acts as a repository and a runner to register/execute health checks.

Example

const healthChecks = new HealthChecks()

healthChecks.register([
  new DiskSpaceCheck().warnWhenExceeds(70).failWhenExceeds(85),
  new MemoryHeapCheck().warnWhenExceeds('200 mb').failWhenExceeds('500 mb')
])

const report = await healthChecks.run()
console.log(report.isHealthy) // true or false

Index

Constructors

constructor

Methods

Constructors

constructor

new HealthChecks(): HealthChecks
Returns HealthChecks

Methods

register

register(checks: HealthCheckContract[]): HealthChecks
Register health checks. Existing health checks will be removed during the register method call
Parameters
- checks: HealthCheckContract[]
  Array of health checks to register
Returns HealthChecks
Example
```
const healthChecks = new HealthChecks()
healthChecks.register([
  new DiskSpaceCheck(),
  new MemoryHeapCheck()
])
```
- Defined in src/health_checks.ts:133

append

append(checks: HealthCheckContract[]): HealthChecks
Append new set of health checks
Parameters
- checks: HealthCheckContract[]
  Array of health checks to append
Returns HealthChecks
Example
```
const healthChecks = new HealthChecks()
healthChecks.register([new DiskSpaceCheck()])
healthChecks.append([new MemoryHeapCheck()]) // Adds to existing checks
```
- Defined in src/health_checks.ts:150

run

run(): Promise<HealthCheckReport>

Executes all the checks in parallel and returns the health check report

Returns Promise<HealthCheckReport>

Example

const healthChecks = new HealthChecks()
const report = await healthChecks.run()

console.log(report.isHealthy) // true or false
console.log(report.status) // 'ok' | 'warning' | 'error'
console.log(report.checks) // Array of check results

Class HealthChecks

Example

Index

Constructors

Methods

Constructors

constructor

Returns HealthChecks

Methods

register

Parameters

Returns HealthChecks

Example

append

Parameters

Returns HealthChecks

Example

run

Returns Promise<HealthCheckReport>

Example

Settings

On This Page