Skip to content

Commit

Permalink
add jsdoc for #77728
Browse files Browse the repository at this point in the history
  • Loading branch information
jrieken committed Feb 10, 2020
1 parent b6d859d commit 7ecb3a3
Showing 1 changed file with 21 additions and 0 deletions.
21 changes: 21 additions & 0 deletions src/vs/vscode.proposed.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1464,10 +1464,31 @@ declare module 'vscode' {

//#region https://github.com/microsoft/vscode/issues/77728

/**
* Additional data for entries of a workspace edit. Supports to label entries and marks entries
* as needing confirmation by the user. The editor groups edits with equal labels into tree nodes,
* for instance all edits labelled with "Changes in Strings" would be a tree node.
*/
export interface WorkspaceEditMetadata {

/**
* A flag which indicates that user confirmation is needed.
*/
needsConfirmation: boolean;

/**
* A human-readable string which is rendered prominent.
*/
label: string;

/**
* A human-readable string which is rendered less prominent in the same line.
*/
description?: string;

/**
* The icon path or [ThemeIcon](#ThemeIcon) for the edit.
*/
iconPath?: Uri | { light: Uri; dark: Uri } | ThemeIcon;
}

Expand Down

0 comments on commit 7ecb3a3

Please sign in to comment.