auth.provider API
    Preparing search index...

    Interface ReadinessProbe

    A liveness signal for one backing dependency.

    Probes are registered by whoever owns the connection — the builder that opened it — because that is the only place holding a reference to it. An adapter's public interface is a narrow command surface (get / set / del), deliberately without a ping, so the composition root cannot construct this from the outside.

    interface ReadinessProbe {
        name: string;
        check(): Promise<unknown>;
    }
    Index
    name
    check
    name: string

    Identifies the dependency in the readiness response. Use the resource, not the module: "redis", "session-store", "database".

    • Resolve when the dependency is reachable; throw or reject when it is not. The return value is ignored — only settlement matters.

      Returns Promise<unknown>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods