Type alias HealthCheckRegistration

HealthCheckRegistration: {
    failureStatus?: HealthStatus;
    instance: HealthCheck;
    name: string;
    tags: string[];
    timeoutMilliseconds?: number;
}

Represent the registration information associated with an HealthCheck implementation.

Type declaration

  • Optional failureStatus?: HealthStatus

    The HealthStatus that should be reported upon failure of the health check.

  • instance: HealthCheck

    A HealthCheck instance.

  • name: string

    The health check name.

  • tags: string[]

    A list of tags that can be used for filtering health checks.

  • Optional timeoutMilliseconds?: number

    The timeout used for the test.

Settings

Member Visibility

Theme

Generated using TypeDoc