Interface StageRenderContext

Context passed to renderStage.

interface StageRenderContext {
    description?: string;
    isFirst: boolean;
    loopIteration?: number;
    resumed?: boolean;
    stageName: string;
    stageNumber: number;
}

Properties

description?: string

isFirst: boolean

loopIteration?: number

Loop iteration number (1-based). Present when this stage is visited via loopTo().

resumed?: boolean

True for the stage a resume re-entered: its arrival was already told by the resume entry.

stageName: string

stageNumber: number