Interface TimelineItem

Structured event accepted by Timeline.

interface TimelineItem {
    id: string;
    title: string;
    detail?: string;
    timestamp?: string | number | Date;
    tone?: StatusTone;
}

Properties

id: string

Stable item id used by adapters and callers.

title: string

Primary event text. ANSI sequences and Blessed tags are stripped.

detail?: string

Optional secondary event text.

timestamp?: string | number | Date

Event timestamp rendered when showTimestamp is enabled.

Semantic event state used for the timeline marker.