Interface LogViewerStateModel

Headless LogViewer state model.

interface LogViewerStateModel {
    append(entry: LogEntry): LogEntry[];
    appendMany(entries: readonly LogEntry[]): LogEntry[];
    clear(): void;
    entries(): readonly LogEntry[];
    isPaused(): boolean;
    pendingEntries(): readonly LogEntry[];
    pause(): void;
    resume(): readonly LogEntry[];
    setOptions(options: CreateLogViewerStateOptions): void;
}

Index

Methods

append appendMany clear entries isPaused pendingEntries pause resume setOptions

Methods

append

append(entry: LogEntry): LogEntry[]
Appends one entry, or queues it while paused.
Parameters
- entry: LogEntry
Returns LogEntry[]
- Defined in components/collections/log-viewer/index.ts:93

appendMany

appendMany(entries: readonly LogEntry[]): LogEntry[]
Appends multiple entries, or queues them while paused.
Parameters
- entries: readonly LogEntry[]
Returns LogEntry[]
- Defined in components/collections/log-viewer/index.ts:96

clear

clear(): void
Clears visible and queued entries.

Returns void
- Defined in components/collections/log-viewer/index.ts:99

entries

entries(): readonly LogEntry[]
Returns retained visible entries.

Returns readonly LogEntry[]
- Defined in components/collections/log-viewer/index.ts:102

isPaused

isPaused(): boolean
Returns whether append operations are queued.

Returns boolean
- Defined in components/collections/log-viewer/index.ts:105

pendingEntries

pendingEntries(): readonly LogEntry[]
Returns queued entries not yet visible.

Returns readonly LogEntry[]
- Defined in components/collections/log-viewer/index.ts:108

pause

pause(): void
Starts queueing appended entries.

Returns void
- Defined in components/collections/log-viewer/index.ts:111

resume

resume(): readonly LogEntry[]
Flushes queued entries and returns visible entries.

Returns readonly LogEntry[]
- Defined in components/collections/log-viewer/index.ts:114

setOptions

setOptions(options: CreateLogViewerStateOptions): void
Replaces options while preserving visible entries.
Parameters
- options: CreateLogViewerStateOptions
Returns void
- Defined in components/collections/log-viewer/index.ts:117