VS Code API

A workspace edit is a collection of textual and files changes for multiple resources and documents.

Use the applyEdit-function to apply a workspace edit.

Hierarchy

WorkspaceEdit

Index

Constructors（1）

constructor

Properties（1）

size

Methods（10）

Constructors（1）

constructor

new WorkspaceEdit(): WorkspaceEdit

Returns WorkspaceEdit

Properties（1）

Readonly size

size: number

The number of affected resources of textual or resource changes.

Methods（10）

replace

replace(uri: Uri, range: Range, newText: string, metadata?: WorkspaceEditEntryMetadata): void

- Defined in vscode.d.ts:3916
Replace the given range with given text for the given resource.

Parameters
- uri: Uri
  
  A resource identifier.
- range: Range
  
  A range.
- newText: string
  
  A string.
- Optional metadata: WorkspaceEditEntryMetadata
  
  Optional metadata for the entry.
Returns void

insert

insert(uri: Uri, position: Position, newText: string, metadata?: WorkspaceEditEntryMetadata): void

- Defined in vscode.d.ts:3926
Insert the given text at the given position.

Parameters
- uri: Uri
  
  A resource identifier.
- position: Position
  
  A position.
- newText: string
  
  A string.
- Optional metadata: WorkspaceEditEntryMetadata
  
  Optional metadata for the entry.
Returns void

delete

delete(uri: Uri, range: Range, metadata?: WorkspaceEditEntryMetadata): void

- Defined in vscode.d.ts:3935
Delete the text at the given range.

Parameters
- uri: Uri
  
  A resource identifier.
- range: Range
  
  A range.
- Optional metadata: WorkspaceEditEntryMetadata
  
  Optional metadata for the entry.
Returns void

has

has(uri: Uri): boolean

- Defined in vscode.d.ts:3943
Check if a text edit for a resource exists.

Parameters
- uri: Uri
  
  A resource identifier.
Returns boolean

true if the given resource will be touched by this edit.

set

set(uri: Uri, edits: readonly (TextEdit | SnippetTextEdit)[]): void
set(uri: Uri, edits: readonly [TextEdit | SnippetTextEdit, undefined | WorkspaceEditEntryMetadata][]): void
set(uri: Uri, edits: readonly NotebookEdit[]): void
set(uri: Uri, edits: readonly [NotebookEdit, undefined | WorkspaceEditEntryMetadata][]): void

- Defined in vscode.d.ts:3951
Set (and replace) text edits or snippet edits for a resource.

Parameters
- uri: Uri
  
  A resource identifier.
- edits: readonly (TextEdit | SnippetTextEdit)[]
  
  An array of edits.
Returns void
- Defined in vscode.d.ts:3959
Set (and replace) text edits or snippet edits with metadata for a resource.

Parameters
- uri: Uri
  
  A resource identifier.
- edits: readonly [TextEdit | SnippetTextEdit, undefined | WorkspaceEditEntryMetadata][]
  
  An array of edits.
Returns void
- Defined in vscode.d.ts:3967
Set (and replace) notebook edits for a resource.

Parameters
- uri: Uri
  
  A resource identifier.
- edits: readonly NotebookEdit[]
  
  An array of edits.
Returns void
- Defined in vscode.d.ts:3975
Set (and replace) notebook edits with metadata for a resource.

Parameters
- uri: Uri
  
  A resource identifier.
- edits: readonly [NotebookEdit, undefined | WorkspaceEditEntryMetadata][]
  
  An array of edits.
Returns void

get

get(uri: Uri): TextEdit[]

- Defined in vscode.d.ts:3983
Get the text edits for a resource.

Parameters
- uri: Uri
  
  A resource identifier.
Returns TextEdit[]

An array of text edits.

createFile

createFile(uri: Uri, options?: { overwrite?: boolean; ignoreIfExists?: boolean; contents?: Uint8Array | DataTransferFile }, metadata?: WorkspaceEditEntryMetadata): void

- Defined in vscode.d.ts:3996
Create a regular file.

Parameters
- uri: Uri
  
  Uri of the new file.
- Optional options: { overwrite?: boolean; ignoreIfExists?: boolean; contents?: Uint8Array | DataTransferFile }
  
  Defines if an existing file should be overwritten or be ignored. When overwrite and ignoreIfExists are both set overwrite wins. When both are unset and when the file already exists then the edit cannot be applied successfully. The content-property allows to set the initial contents the file is being created with.
  - Optional Readonly overwrite?: boolean
    
    Overwrite existing file. Overwrite wins over ignoreIfExists
  - Optional Readonly ignoreIfExists?: boolean
    
    Do nothing if a file with uri exists already.
  - Optional Readonly contents?: Uint8Array | DataTransferFile
    
    The initial contents of the new file.
    
    If creating a file from a drop operation, you can pass in a DataTransferFile to improve performance by avoiding extra data copying.
- Optional metadata: WorkspaceEditEntryMetadata
  
  Optional metadata for the entry.
Returns void

deleteFile

deleteFile(uri: Uri, options?: { recursive?: boolean; ignoreIfNotExists?: boolean }, metadata?: WorkspaceEditEntryMetadata): void

- Defined in vscode.d.ts:4020
Delete a file or folder.

Parameters
- uri: Uri
  
  The uri of the file that is to be deleted.
- Optional options: { recursive?: boolean; ignoreIfNotExists?: boolean }
  - Optional Readonly recursive?: boolean
    
    Delete the content recursively if a folder is denoted.
  - Optional Readonly ignoreIfNotExists?: boolean
    
    Do nothing if a file with uri exists already.
- Optional metadata: WorkspaceEditEntryMetadata
  
  Optional metadata for the entry.
Returns void

renameFile

renameFile(oldUri: Uri, newUri: Uri, options?: { overwrite?: boolean; ignoreIfExists?: boolean }, metadata?: WorkspaceEditEntryMetadata): void

- Defined in vscode.d.ts:4040
Rename a file or folder.

Parameters
- oldUri: Uri
  
  The existing file.
- newUri: Uri
  
  The new location.
- Optional options: { overwrite?: boolean; ignoreIfExists?: boolean }
  
  Defines if existing files should be overwritten or be ignored. When overwrite and ignoreIfExists are both set overwrite wins.
  - Optional Readonly overwrite?: boolean
    
    Overwrite existing file. Overwrite wins over ignoreIfExists
  - Optional Readonly ignoreIfExists?: boolean
    
    Do nothing if a file with uri exists already.
- Optional metadata: WorkspaceEditEntryMetadata
  
  Optional metadata for the entry.
Returns void

entries

entries(): [Uri, TextEdit[]][]

- Defined in vscode.d.ts:4056
Get all text edits grouped by resource.

Returns [Uri, TextEdit[]][]

A shallow copy of [Uri, TextEdit[]]-tuples.

Hierarchy

Index

Constructors（1）

Properties（1）

Methods（10）

Constructors（1）

constructor

Returns WorkspaceEdit

Properties（1）

Readonly size

Methods（10）

replace

Parameters

uri: Uri

range: Range

newText: string

Optional metadata: WorkspaceEditEntryMetadata

Returns void

insert

Parameters

uri: Uri

position: Position

newText: string

Optional metadata: WorkspaceEditEntryMetadata

Returns void

delete

Parameters

uri: Uri

range: Range

Optional metadata: WorkspaceEditEntryMetadata

Returns void

has

Parameters

uri: Uri

Returns boolean

set

Parameters

uri: Uri

edits: readonly (TextEdit | SnippetTextEdit)[]

Returns void

Parameters

uri: Uri

edits: readonly [TextEdit | SnippetTextEdit, undefined | WorkspaceEditEntryMetadata][]

Returns void

Parameters

uri: Uri

edits: readonly NotebookEdit[]

Returns void

Parameters

uri: Uri

edits: readonly [NotebookEdit, undefined | WorkspaceEditEntryMetadata][]

Returns void

get

Parameters

uri: Uri

Returns TextEdit[]

createFile

Parameters

uri: Uri

Optional options: { overwrite?: boolean; ignoreIfExists?: boolean; contents?: Uint8Array | DataTransferFile }

Optional Readonly overwrite?: boolean

Optional Readonly ignoreIfExists?: boolean

Optional Readonly contents?: Uint8Array | DataTransferFile

Optional metadata: WorkspaceEditEntryMetadata

Returns void

deleteFile

Parameters

uri: Uri

Optional options: { recursive?: boolean; ignoreIfNotExists?: boolean }

Optional Readonly recursive?: boolean

Optional Readonly ignoreIfNotExists?: boolean

Optional metadata: WorkspaceEditEntryMetadata

Returns void

renameFile

Parameters

oldUri: Uri

newUri: Uri

Optional options: { overwrite?: boolean; ignoreIfExists?: boolean }

Optional Readonly overwrite?: boolean

Optional Readonly ignoreIfExists?: boolean