Type alias HealthReportEntry

HealthReportEntry: {
    data?: {
        [key: string]: any;
    };
    description?: string;
    duration: string;
    exception?: unknown;
    status: HealthStatus;
    tags: string[];
}

Represents an entry in a HealthReport. Corresponds to the result of a single HealthCheck.

Type declaration

  • Optional data?: {
        [key: string]: any;
    }

    Additional key-value pairs describing the health of the component.

    • [key: string]: any
  • Optional description?: string

    A human-readable description of the status of the component that was checked.

  • duration: string

    The health check execution duration.

  • Optional exception?: unknown

    An Exception(JS Error) representing the exception that was thrown when checking for status (if any).

  • status: HealthStatus

    The health status of the component that was checked.

  • tags: string[]

    The tags associated with the health check.

Settings

Member Visibility

Theme

Generated using TypeDoc