blessed-components - v1.20.0
    Preparing search index...

    Interface HealthIndicatorData

    Stateful data accepted by the Blessed healthIndicator adapter.

    interface HealthIndicatorData {
        backgroundTone?: keyof ThemeColors;
        borderTone?: keyof ThemeColors;
        theme?: Theme;
        capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">;
        foregroundTone?: keyof ThemeColors;
        markers?: StatusMarkers;
        height?: number;
        label?: string;
        maxReasons?: number;
        services: readonly HealthIndicatorService[];
        showReasons?: boolean;
        width?: number;
        detailSeparator?: string;
        marker?: string;
        showMarker?: boolean;
    }

    Hierarchy

    Index

    Properties

    backgroundTone? borderTone? theme? capabilities? foregroundTone? markers? height? label? maxReasons? services showReasons? width? detailSeparator? marker? showMarker?

    Properties

    backgroundTone?: keyof ThemeColors

    Semantic background token.

    'background'

    borderTone?: keyof ThemeColors

    Semantic border token.

    'border'

    theme?: Theme

    Semantic terminal theme.

    capabilities?: Pick<TerminalCapabilities, "unicode" | "colorLevel">

    Explicit terminal capabilities used for deterministic rendering.

    foregroundTone?: keyof ThemeColors

    Semantic foreground token. Defaults to 'foreground'.

    markers?: StatusMarkers

    Custom semantic markers.

    height?: number

    Maximum rendered line count.

    no limit
    label?: string

    Primary summary label.

    'Health'

    maxReasons?: number

    Maximum reason rows rendered after the summary.

    all reasons
    services: readonly HealthIndicatorService[]

    Services included in the health summary.

    showReasons?: boolean

    Whether service reasons are rendered after the summary.

    true

    width?: number

    Maximum rendered width measured in terminal cells.

    detailSeparator?: string

    Separator inserted between label and detail.

    ' - '

    marker?: string

    Explicit marker rendered before the label.

    showMarker?: boolean

    Whether the semantic marker is rendered.

    true

    Settings

    Member Visibility

    On This Page

    Properties