WorkspaceEdit class

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

Use the {@link workspace.applyEditapplyEdit}-function to apply a workspace edit.

Available extensions
Annotations
  • @JS()
  • @staticInterop

Constructors

WorkspaceEdit()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
set → ({void Function(Uri uri, ReadonlyArray<Object> edits) $1, void Function(Uri uri, ReadonlyArray<(Object, WorkspaceEditEntryMetadata)> edits) $2, void Function(Uri uri, List<NotebookEdit> edits) $3, void Function(Uri uri, ReadonlyArray<(NotebookEdit, WorkspaceEditEntryMetadata)> edits) $4})

Available on WorkspaceEdit, provided by the WorkspaceEdit$Typings extension

Overload accessor: $1, $2, $3, $4
no setter
size → num

Available on WorkspaceEdit, provided by the WorkspaceEdit$Typings extension

The number of affected resources of textual or resource changes.
no setter

Methods

createFile(Uri uri, [IInline20? options, WorkspaceEditEntryMetadata? metadata]) → void

Available on WorkspaceEdit, provided by the WorkspaceEdit$Typings extension

Create a regular file.
delete(Uri uri, Range range, [WorkspaceEditEntryMetadata? metadata]) → void

Available on WorkspaceEdit, provided by the WorkspaceEdit$Typings extension

Delete the text at the given range.
deleteFile(Uri uri, [IInline21? options, WorkspaceEditEntryMetadata? metadata]) → void

Available on WorkspaceEdit, provided by the WorkspaceEdit$Typings extension

Delete a file or folder.
entries() → List<(Uri, List<TextEdit>)>

Available on WorkspaceEdit, provided by the WorkspaceEdit$Typings extension

Get all text edits grouped by resource.
get(Uri uri) → List<TextEdit>

Available on WorkspaceEdit, provided by the WorkspaceEdit$Typings extension

Get the text edits for a resource.
has(Uri uri) → bool

Available on WorkspaceEdit, provided by the WorkspaceEdit$Typings extension

Check if a text edit for a resource exists.
insert(Uri uri, Position position, String newText, [WorkspaceEditEntryMetadata? metadata]) → void

Available on WorkspaceEdit, provided by the WorkspaceEdit$Typings extension

Insert the given text at the given position.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
renameFile(Uri oldUri, Uri newUri, [IInline22? options, WorkspaceEditEntryMetadata? metadata]) → void

Available on WorkspaceEdit, provided by the WorkspaceEdit$Typings extension

Rename a file or folder.
replace(Uri uri, Range range, String newText, [WorkspaceEditEntryMetadata? metadata]) → void

Available on WorkspaceEdit, provided by the WorkspaceEdit$Typings extension

Replace the given range with given text for the given resource.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited