more jsdoc, clarify that deleting/renaming a folder sends only 1 event, #43768
This commit is contained in:
parent
29b99f85e5
commit
3e0dab8653
1 changed files with 43 additions and 9 deletions
52
src/vs/vscode.proposed.d.ts
vendored
52
src/vs/vscode.proposed.d.ts
vendored
|
@ -888,7 +888,7 @@ declare module 'vscode' {
|
|||
/**
|
||||
* An event that is emitted when files are being created.
|
||||
*
|
||||
* *Note* that this event is triggered by user gestures, like creating a file from the
|
||||
* *Note:* This event is triggered by user gestures, like creating a file from the
|
||||
* explorer, or from the [`workspace.applyEdit`](#workspace.applyEdit)-api. This event is *not* fired when
|
||||
* files change on disk, e.g triggered by another application, or when using the
|
||||
* [`workspace.fs`](#FileSystem)-api.
|
||||
|
@ -896,27 +896,61 @@ declare module 'vscode' {
|
|||
export const onWillCreateFiles: Event<FileWillCreateEvent>;
|
||||
|
||||
/**
|
||||
* An event that is emitted when files are being deleted.
|
||||
* An event that is emitted when files have been created.
|
||||
*
|
||||
* *Note* that this event is triggered by user gestures, like deleting a file from the
|
||||
* explorer, or from the [`workspace.applyEdit`](#workspace.applyEdit)-api. This event is *not* fired when
|
||||
* *Note:* This event is triggered by user gestures, like creating a file from the
|
||||
* explorer, or from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
|
||||
* files change on disk, e.g triggered by another application, or when using the
|
||||
* [`workspace.fs`](#FileSystem)-api.
|
||||
*/
|
||||
export const onDidCreateFiles: Event<FileCreateEvent>;
|
||||
|
||||
/**
|
||||
* An event that is emitted when files are being deleted.
|
||||
*
|
||||
* *Note 1:* This event is triggered by user gestures, like deleting a file from the
|
||||
* explorer, or from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
|
||||
* files change on disk, e.g triggered by another application, or when using the
|
||||
* [`workspace.fs`](#FileSystem)-api.
|
||||
*
|
||||
* *Note 2:* When deleting a folder with children only one event is fired.
|
||||
*/
|
||||
export const onWillDeleteFiles: Event<FileWillDeleteEvent>;
|
||||
|
||||
/**
|
||||
* An event that is emitted when files are being renamed.
|
||||
* An event that is emitted when files have been deleted.
|
||||
*
|
||||
* *Note* that this event is triggered by user gestures, like renaming a file from the
|
||||
* explorer, and from the [`workspace.applyEdit`](#workspace.applyEdit)-api. This event is *not* fired when
|
||||
* *Note 1:* This event is triggered by user gestures, like deleting a file from the
|
||||
* explorer, or from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
|
||||
* files change on disk, e.g triggered by another application, or when using the
|
||||
* [`workspace.fs`](#FileSystem)-api.
|
||||
*
|
||||
* *Note 2:* When deleting a folder with children only one event is fired.
|
||||
*/
|
||||
export const onDidDeleteFiles: Event<FileDeleteEvent>;
|
||||
|
||||
/**
|
||||
* An event that is emitted when files are being renamed.
|
||||
*
|
||||
* *Note 1:* This event is triggered by user gestures, like renaming a file from the
|
||||
* explorer, and from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
|
||||
* files change on disk, e.g triggered by another application, or when using the
|
||||
* [`workspace.fs`](#FileSystem)-api.
|
||||
*
|
||||
* *Note 2:* When renaming a folder with children only one event is fired.
|
||||
*/
|
||||
export const onWillRenameFiles: Event<FileWillRenameEvent>;
|
||||
|
||||
export const onDidCreateFiles: Event<FileCreateEvent>;
|
||||
export const onDidDeleteFiles: Event<FileDeleteEvent>;
|
||||
/**
|
||||
* An event that is emitted when files have been renamed.
|
||||
*
|
||||
* *Note 1:* This event is triggered by user gestures, like renaming a file from the
|
||||
* explorer, and from the [`workspace.applyEdit`](#workspace.applyEdit)-api, but this event is *not* fired when
|
||||
* files change on disk, e.g triggered by another application, or when using the
|
||||
* [`workspace.fs`](#FileSystem)-api.
|
||||
*
|
||||
* *Note 2:* When renaming a folder with children only one event is fired.
|
||||
*/
|
||||
export const onDidRenameFiles: Event<FileRenameEvent>;
|
||||
}
|
||||
//#endregion
|
||||
|
|
Loading…
Reference in a new issue