Setu-TS
    Preparing search index...

    Interface IHealthService

    Health service contract for registering and checking health indicators.

    Resolved via CAPABILITIES.HEALTH ('health').

    const health = ctx.services.get<IHealthService>('health');
    health.registerIndicator('custom', async () => ({ status: 'up' }));
    const report = await health.check();

    0.2.0

    interface IHealthService {
        check(): Promise<HealthReport>;
        checkLive(): Promise<HealthReport>;
        checkReady(): Promise<HealthReport>;
        registerIndicator(
            name: string,
            indicator: HealthIndicatorFn,
            options?: HealthIndicatorOptions,
        ): void;
    }

    Implemented by

    Index
    check checkLive checkReady registerIndicator

    Settings
    Member Visibility

    On This Page
    Methods