IQHealthcheck
@quik/core / IQHealthcheck
Interface: IQHealthcheck
Defined in: types/IQHealthcheck.ts:14
Interface describing the contract for a Healthcheck engine implementation.
Methods
all()
all():
Record<string,HealthcheckStatus>
Defined in: types/IQHealthcheck.ts:15
Returns
Record<string, HealthcheckStatus>
degraded()
degraded(
item):void
Defined in: types/IQHealthcheck.ts:42
Mark the health check item as degraded.
Parameters
item
string
Returns
void
down()
down(
item):void
Defined in: types/IQHealthcheck.ts:33
Mark the health check item as down.
Parameters
item
string
Returns
void
ok()
ok(
item):void
Defined in: types/IQHealthcheck.ts:27
Mark the health check item as ok.
Parameters
item
string
Returns
void
pending()
pending(
item):void
Defined in: types/IQHealthcheck.ts:39
Mark the health check item as pending.
Parameters
item
string
Returns
void
ready()
ready(
item):void
Defined in: types/IQHealthcheck.ts:36
Mark the health check item as ready.
Parameters
item
string
Returns
void
register()
register(
item):void
Defined in: types/IQHealthcheck.ts:18
Register healthcheck item
Parameters
item
string
Returns
void
registerCheck()?
optionalregisterCheck(name,check,options?):void
Defined in: types/IQHealthcheck.ts:45
Register a healthcheck function.
Parameters
name
string
check
options?
Returns
void
runChecks()?
optionalrunChecks(options?):Promise<Record<string,HealthcheckStatus>>
Defined in: types/IQHealthcheck.ts:48
Execute registered checks and update statuses.
Parameters
options?
timeoutMs?
number
Returns
Promise<Record<string, HealthcheckStatus>>
set()
set(
item,status):void
Defined in: types/IQHealthcheck.ts:24
Set the status of the health check item.
Parameters
item
string
status
Returns
void
status()
status(
item):HealthcheckStatus
Defined in: types/IQHealthcheck.ts:21
The status of the health check item.
Parameters
item
string
Returns
unready()
unready(
item):void
Defined in: types/IQHealthcheck.ts:30
Mark the health check item as unready.
Parameters
item
string
Returns
void