Represents a step in the health check process. Each step has a name for easier debugging as well as an async predicate.

interface Condition {
    name: string;
    run: (() => Promise<boolean>);
}

Properties

Properties

name: string

The name of this condition. This is shared with the Gatus server if the Condition fails or throws an error.

run: (() => Promise<boolean>)

Async predicate for the step. Resolves to true on success.