export type CheckStatus = 'up' | 'down'; export type CheckDetails = Record; /** * Check result is an outcome for a check. It is * a little specialized version of classical Result * abstraction with error and data */ export declare class CheckResult { /** * Check status */ readonly status: CheckStatus; /** * Custom attributes (key value) Will * be returned to check caller or/and logged */ readonly details: CheckDetails; private constructor(); /** * Indicated that check was not successful */ get isError(): boolean; /** * Creates successful CheckResult * * @param details Any custom attributes * @returns CheckResult */ static up(details: CheckDetails): CheckResult; /** * Creates failed CheckResult * * @param details Any custom attributes * @returns CheckResult */ static down(details: CheckDetails): CheckResult; }