Beignet API reference
    Preparing search index...

    Interface UpstashRateLimitHealth

    Readiness result returned by the Upstash escape hatch.

    interface UpstashRateLimitHealth {
        message?: string;
        metadata: {
            adapter: "upstash";
            algorithm: UpstashRateLimitAlgorithm;
            prefix: string;
            timeoutMs: number;
            timeoutPolicy: UpstashRateLimitTimeoutPolicy;
        };
        ok: boolean;
    }
    Index
    message? metadata ok
    message?: string

    Dependency error message when the check is unhealthy.

    metadata: {
        adapter: "upstash";
        algorithm: UpstashRateLimitAlgorithm;
        prefix: string;
        timeoutMs: number;
        timeoutPolicy: UpstashRateLimitTimeoutPolicy;
    }

    Non-secret provider configuration useful in readiness diagnostics.

    ok: boolean

    Whether the Redis PING completed successfully.

    Settings
    Member Visibility

    On This Page
    Properties