External module "health/checks"

Index

Enumerations

HealthCheckResult

Interfaces

Dependency

Variables

Functions

Variables

Const MILLISECOND

MILLISECOND: 1 = 1

Const MINUTE

MINUTE: number = 60 * SECOND

Const SECOND

SECOND: number = 1000 * MILLISECOND

Let summary

summary: Error[] = []

Functions

appendHealthCheckError

appendHealthCheckError(err: Error): void

- Defined in health/checks.ts:30
Parameters
- err: Error
Returns void

checkHealthOrTimeout

checkHealthOrTimeout(name: string, timeout: number, check: function): Promise<(OrionError | HC_OK | HC_WARN | HC_CRIT)[]>

- Defined in health/checks.ts:34
Parameters
- name: string
- timeout: number
- check: function
  - - (): Promise<[HealthCheckResult, OrionError | undefined]>
    - Returns Promise<[HealthCheckResult, OrionError | undefined]>
Returns Promise<(OrionError | HC_OK | HC_WARN | HC_CRIT)[]>

getSummaryOfHealthChecks

getSummaryOfHealthChecks(): Error[]

- Defined in health/checks.ts:22
Returns Error[]

resetSummaryOfHealthChecks

resetSummaryOfHealthChecks(): void

- Defined in health/checks.ts:26
Returns void

Generated using TypeDoc