Interface StepRunContext<S>

What each step receives when it runs.

interface StepRunContext<S> {
    backButton: QuickInputButtonLike | undefined;
    ignoreFocusOut: boolean;
    quickInput: QuickInputCapability;
    signal: AbortSignal | undefined;
    state: Readonly<S>;
    step: number | undefined;
    title: string;
    totalSteps: number | undefined;
}

Type Parameters

S

Index

Properties

backButton ignoreFocusOut quickInput signal state step title totalSteps

Properties

`Readonly`backButton

backButton: QuickInputButtonLike | undefined

`Readonly`ignoreFocusOut

ignoreFocusOut: boolean

`Readonly`quickInput

quickInput: QuickInputCapability

The quick-input surface the step builds its UI on.

`Readonly`signal

signal: AbortSignal | undefined

Aborting hides the step's UI and cancels the wizard.

`Readonly`state

state: Readonly<S>

`Readonly`step

step: number | undefined

`Readonly`title

title: string

`Readonly`totalSteps

totalSteps: number | undefined