Interface CombinedNarrativeRecorderOptions

interface CombinedNarrativeRecorderOptions {
    formatValue?: (value: unknown, maxLen: number) => string;
    includeStepNumbers?: boolean;
    includeValues?: boolean;
    maxValueLength?: number;
    renderer?: NarrativeFormatter;
}

Properties

formatValue?: (value: unknown, maxLen: number) => string

Custom value formatter. Called at render time (flushOps), not capture time. Receives the raw value and maxValueLength. Defaults to summarizeValue().

includeStepNumbers?: boolean

includeValues?: boolean

maxValueLength?: number

Pluggable renderer for customizing narrative output. Unimplemented methods fall back to the default English renderer. See NarrativeFormatter docs.