Interface WorkspaceEditOptions

Metadata for a cross-file edit, surfaced in the refactor-preview UI.

interface WorkspaceEditOptions {
    isRefactoring?: boolean;
    label?: string;
    needsConfirmation?: boolean;
    signal?: AbortSignal;
}

Properties

isRefactoring?: boolean

Marks the whole edit as a refactoring.

label?: string

Label shown in the undo stack and the preview UI.

needsConfirmation?: boolean

Whether the user is asked to confirm before the edit lands.

signal?: AbortSignal

Checked while the edit is assembled, so a very large batch stops promptly instead of building a transaction nobody is waiting for.