Skip to main content

QDefaultHealthcheck

@quik/core

@quik/core / QDefaultHealthcheck

Class: QDefaultHealthcheck

Defined in: features/QHealthcheck.ts:9

No-op healthcheck feature implementation.

Implements​

Constructors​

Constructor​

new QDefaultHealthcheck(): QDefaultHealthcheck

Returns​

QDefaultHealthcheck

Methods​

all()​

all(): Record<string, HealthcheckStatus>

Defined in: features/QHealthcheck.ts:13

Return all healthcheck statuses.

Returns​

Record<string, HealthcheckStatus>

Implementation of​

IQHealthcheck.all

degraded()​

degraded(item): void

Defined in: features/QHealthcheck.ts:52

Mark the health check item as degraded.

Parameters​

item​

string

Returns​

void

Implementation of​

IQHealthcheck.degraded

down()​

down(item): void

Defined in: features/QHealthcheck.ts:46

Mark the health check item as down.

Parameters​

item​

string

Returns​

void

Implementation of​

IQHealthcheck.down

ok()​

ok(item): void

Defined in: features/QHealthcheck.ts:42

Mark the health check item as ok.

Parameters​

item​

string

Returns​

void

Implementation of​

IQHealthcheck.ok

pending()​

pending(item): void

Defined in: features/QHealthcheck.ts:50

Mark the health check item as pending.

Parameters​

item​

string

Returns​

void

Implementation of​

IQHealthcheck.pending

ready()​

ready(item): void

Defined in: features/QHealthcheck.ts:48

Mark the health check item as ready.

Parameters​

item​

string

Returns​

void

Implementation of​

IQHealthcheck.ready

register()​

register(item): void

Defined in: features/QHealthcheck.ts:22

Register a healthcheck item.

Parameters​

item​

string

Healthcheck identifier.

Returns​

void

Implementation of​

IQHealthcheck.register

set()​

set(item, status): void

Defined in: features/QHealthcheck.ts:39

Set the status of a healthcheck item.

Parameters​

item​

string

Healthcheck identifier.

status​

HealthcheckStatus

New status.

Returns​

void

Implementation of​

IQHealthcheck.set

status()​

status(item): HealthcheckStatus

Defined in: features/QHealthcheck.ts:29

Get the status of a healthcheck item.

Parameters​

item​

string

Healthcheck identifier.

Returns​

HealthcheckStatus

Implementation of​

IQHealthcheck.status

unready()​

unready(item): void

Defined in: features/QHealthcheck.ts:44

Mark the health check item as unready.

Parameters​

item​

string

Returns​

void

Implementation of​

IQHealthcheck.unready