WorkspaceEdit | Theia TypeDoc

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

constructor

Properties

size

Methods

Constructors

constructor

new WorkspaceEdit(): WorkspaceEdit

Returns WorkspaceEdit

Properties

Readonly size

size: number

The number of affected resources of textual or resource changes.

Methods

createFile

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

- Defined in packages/plugin/src/theia.d.ts:10055
Create a regular file.

Parameters
- uri: Uri
  
  Uri of the new file..
- Optional options: { ignoreIfExists?: boolean; overwrite?: boolean }
  
  Defines if an existing file should be overwritten or be ignored. When overwrite and ignoreIfExists are both set overwrite wins.
  - Optional ignoreIfExists?: boolean
  - Optional overwrite?: boolean
- Optional metadata: WorkspaceEditEntryMetadata
  
  Optional metadata for the entry.
Returns void

delete

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

- Defined in packages/plugin/src/theia.d.ts:10013
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

deleteFile

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

- Defined in packages/plugin/src/theia.d.ts:10063
Delete a file or folder.

Parameters
- uri: Uri
  
  The uri of the file that is to be deleted.
- Optional options: { ignoreIfNotExists?: boolean; recursive?: boolean }
  - Optional ignoreIfNotExists?: boolean
  - Optional recursive?: boolean
- Optional metadata: WorkspaceEditEntryMetadata
  
  Optional metadata for the entry.
Returns void

entries

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

- Defined in packages/plugin/src/theia.d.ts:10081
Get all text edits grouped by resource.

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

get

get(uri: Uri): TextEdit[]

- Defined in packages/plugin/src/theia.d.ts:10045
Get the text edits for a resource.

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

has

has(uri: Uri): boolean

- Defined in packages/plugin/src/theia.d.ts:10021
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.

insert

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

- Defined in packages/plugin/src/theia.d.ts:10004
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

renameFile

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

- Defined in packages/plugin/src/theia.d.ts:10074
Rename a file or folder.

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

replace

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

- Defined in packages/plugin/src/theia.d.ts:9994
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

set

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

- Defined in packages/plugin/src/theia.d.ts:10029
Set (and replace) text edits for a resource.

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

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

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Returns WorkspaceEdit

Properties

Readonly size

Methods

createFile

Parameters

uri: Uri

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

Optional ignoreIfExists?: boolean

Optional overwrite?: boolean

Optional metadata: WorkspaceEditEntryMetadata

Returns void

delete

Parameters

uri: Uri

range: Range

Optional metadata: WorkspaceEditEntryMetadata

Returns void

deleteFile

Parameters

uri: Uri

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

Optional ignoreIfNotExists?: boolean

Optional recursive?: boolean

Optional metadata: WorkspaceEditEntryMetadata

Returns void

entries

Returns [Uri, TextEdit[]][]

get

Parameters

uri: Uri

Returns TextEdit[]

has

Parameters

uri: Uri

Returns boolean

insert

Parameters

uri: Uri

position: Position

newText: string

Optional metadata: WorkspaceEditEntryMetadata

Returns void

renameFile

Parameters

oldUri: Uri

newUri: Uri

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

Optional ignoreIfExists?: boolean

Optional overwrite?: boolean

Optional metadata: WorkspaceEditEntryMetadata

Returns void

replace

Parameters

uri: Uri

range: Range

newText: string

Optional metadata: WorkspaceEditEntryMetadata

Returns void

set

Parameters

uri: Uri

edits: readonly (TextEdit | SnippetTextEdit)[]

Returns void

Parameters

uri: Uri

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

Returns void