Class WorkspaceEdit

Hierarchy

WorkspaceEdit

Implements

WorkspaceEdit

Index

Constructors

constructor

Properties

_edits

Accessors

size

Methods

Constructors

constructor

new WorkspaceEdit(): WorkspaceEdit

Returns WorkspaceEdit

Properties

Private _edits

_edits: (undefined | FileOperation | FileTextEdit)[] = ...

Accessors

size

get size(): number

- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1385
Returns number

Methods

_allEntries

_allEntries(): ([URI, TextEdit[], WorkspaceEditMetadata] | [URI, URI, FileOperationOptions, WorkspaceEditMetadata])[]

- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1370
Returns ([URI, TextEdit[], WorkspaceEditMetadata] | [URI, URI, FileOperationOptions, WorkspaceEditMetadata])[]

createFile

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

Implementation of theia.WorkspaceEdit.createFile
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1291
Parameters
- uri: Uri
- Optional options: { ignoreIfExists?: boolean; overwrite?: boolean }
  - Optional ignoreIfExists?: boolean
  - Optional overwrite?: boolean
- Optional metadata: WorkspaceEditMetadata
Returns void

delete

delete(resource: URI, range: Range, metadata?: WorkspaceEditMetadata): void

Implementation of theia.WorkspaceEdit.delete
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1307
Parameters
- resource: URI
- range: Range
- Optional metadata: WorkspaceEditMetadata
Returns void

deleteFile

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

Implementation of theia.WorkspaceEdit.deleteFile
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1295
Parameters
- uri: Uri
- Optional options: { ignoreIfNotExists?: boolean; recursive?: boolean }
  - Optional ignoreIfNotExists?: boolean
  - Optional recursive?: boolean
- Optional metadata: WorkspaceEditMetadata
Returns void

entries

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

Implementation of theia.WorkspaceEdit.entries
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1353
Returns [URI, TextEdit[]][]

get

get(uri: URI): TextEdit[]

Implementation of theia.WorkspaceEdit.get
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1340
Parameters
- uri: URI
Returns TextEdit[]

has

has(uri: URI): boolean

Implementation of theia.WorkspaceEdit.has
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1311
Parameters
- uri: URI
Returns boolean

insert

insert(resource: URI, position: Position, newText: string, metadata?: WorkspaceEditMetadata): void

Implementation of theia.WorkspaceEdit.insert
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1303
Parameters
- resource: URI
- position: Position
- newText: string
- Optional metadata: WorkspaceEditMetadata
Returns void

renameFile

renameFile(from: Uri, to: Uri, options?: { ignoreIfExists?: boolean; overwrite?: boolean }, metadata?: WorkspaceEditMetadata): void

Implementation of theia.WorkspaceEdit.renameFile
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1287
Parameters
- from: Uri
- to: Uri
- Optional options: { ignoreIfExists?: boolean; overwrite?: boolean }
  - Optional ignoreIfExists?: boolean
  - Optional overwrite?: boolean
- Optional metadata: WorkspaceEditMetadata
Returns void

replace

replace(uri: URI, range: Range, newText: string, metadata?: WorkspaceEditMetadata): void

Implementation of theia.WorkspaceEdit.replace
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1299
Parameters
- uri: URI
- range: Range
- newText: string
- Optional metadata: WorkspaceEditMetadata
Returns void

set

set(uri: URI, edits: TextEdit[]): void

Implementation of theia.WorkspaceEdit.set
- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1320
Parameters
- uri: URI
- edits: TextEdit[]
Returns void

toJSON

toJSON(): any

- Defined in packages/plugin-ext/src/plugin/types-impl.ts:1390
Returns any