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

    Interface RenderConnectionStatusOptions

    Options accepted by renderConnectionStatus.

    interface RenderConnectionStatusOptions {
        detail?: string;
        state?: ConnectionState;
        latency?: number;
        label?: string;
        detailSeparator?: string;
        marker?: string;
        markers?: StatusMarkers;
        showMarker?: boolean;
    }

    Hierarchy

    Index

    Properties

    detail? state? latency? label? detailSeparator? marker? markers? showMarker?

    Properties

    detail?: string

    Additional detail rendered after latency, when present.

    state?: ConnectionState

    Current connection state.

    'online'

    latency?: number

    Optional latency in milliseconds.

    Must be a non-negative finite number.

    label?: string

    Explicit primary label. Defaults to a label derived from state.

    detailSeparator?: string

    Separator inserted between label and detail.

    ' - '

    marker?: string

    Explicit marker rendered before the label.

    markers?: StatusMarkers

    Semantic marker mapping.

    Every marker must be exactly one terminal cell wide.

    STATUS_UNICODE_MARKERS

    showMarker?: boolean

    Whether the semantic marker is rendered.

    true

    Settings

    Member Visibility

    On This Page

    Properties