WorkspaceEdit | 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.

层级

WorkspaceEdit

索引

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:3281
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:3291
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:3300
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:3308
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: TextEdit[]): void

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

Parameters
- uri: Uri
  
  A resource identifier.
- edits: TextEdit[]
  
  An array of text edits.
Returns void

get

get(uri: Uri): TextEdit[]

- Defined in vscode.d.ts:3324
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 }, metadata?: WorkspaceEditEntryMetadata): void

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

Parameters
- uri: Uri
  
  Uri of the new file..
- Optional options: { overwrite?: boolean; ignoreIfExists?: boolean }
  
  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.
  - Optional overwrite?: boolean
  - Optional ignoreIfExists?: boolean
- 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:3344
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 recursive?: boolean
  - Optional ignoreIfNotExists?: boolean
- 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:3355
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 overwrite?: boolean
  - Optional ignoreIfExists?: boolean
- Optional metadata: WorkspaceEditEntryMetadata
  
  Optional metadata for the entry.
Returns void

entries

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

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

Returns [Uri, TextEdit[]][]

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

层级

索引

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: TextEdit[]

Returns void

get

Parameters

uri: Uri

Returns TextEdit[]

createFile

Parameters

uri: Uri

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

Optional overwrite?: boolean

Optional ignoreIfExists?: boolean

Optional metadata: WorkspaceEditEntryMetadata

Returns void

deleteFile

Parameters

uri: Uri

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

Optional recursive?: boolean

Optional ignoreIfNotExists?: boolean

Optional metadata: WorkspaceEditEntryMetadata

Returns void

renameFile

Parameters

oldUri: Uri

newUri: Uri

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

Optional overwrite?: boolean

Optional ignoreIfExists?: boolean

Optional metadata: WorkspaceEditEntryMetadata

Returns void

entries

Returns [Uri, TextEdit[]][]