Class WorkspaceEdit

constructor

• new WorkspaceEdit(): WorkspaceEdit

• Returns WorkspaceEdit

Readonly size

createFile

• createFile(uri, options?, metadata?): void

• 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, range, metadata?): void

• 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, options?, metadata?): void

• 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[]][]

• Get all text edits grouped by resource.

  Returns [Uri, TextEdit[]][]

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

get

• get(uri): TextEdit[]

• Get the text edits for a resource.

  Parameters

  • uri: Uri

    A resource identifier.

  Returns TextEdit[]

  An array of text edits.

has

• has(uri): boolean

• 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, position, newText, metadata?): void

• 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, newUri, options?, metadata?): void

• 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, range, newText, metadata?): void

• 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, edits): void

• 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
• set(uri, edits): void

• 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
• set(uri, edits): void

• Set (and replace) notebook edits for a resource.

  Parameters

  • uri: Uri

    A resource identifier.
  • edits: readonly NotebookEdit[]

    An array of edits.

  Returns void
• set(uri, edits): void

• 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