Skip to main content

HealthMonitor

@codebolt/types


Interface: HealthMonitor

Defined in: common/types/src/codeboltjstypes/libFunctionTypes/internal.ts:543

Methods​

checkAll()​

checkAll(): Promise<Map<string, HealthStatus>>;

Defined in: common/types/src/codeboltjstypes/libFunctionTypes/internal.ts:546

Returns​

Promise<Map<string, HealthStatus>>


getStatus()​

getStatus(name: string): HealthStatus;

Defined in: common/types/src/codeboltjstypes/libFunctionTypes/internal.ts:547

Parameters​

ParameterType
namestring

Returns​

HealthStatus


isHealthy()​

isHealthy(): boolean;

Defined in: common/types/src/codeboltjstypes/libFunctionTypes/internal.ts:548

Returns​

boolean


register()​

register(check: HealthCheck): void;

Defined in: common/types/src/codeboltjstypes/libFunctionTypes/internal.ts:544

Parameters​

ParameterType
checkHealthCheck

Returns​

void


unregister()​

unregister(name: string): void;

Defined in: common/types/src/codeboltjstypes/libFunctionTypes/internal.ts:545

Parameters​

ParameterType
namestring

Returns​

void