Class WorkspaceEdit

constructor

• new WorkspaceEdit(): WorkspaceEdit

  Returns WorkspaceEdit

Readonlysize

createFile

• createFile(
      uri: Uri,
      options?: {
          contents?: Uint8Array<ArrayBufferLike> | DataTransferFile;
          ignoreIfExists?: boolean;
          overwrite?: boolean;
      },
      metadata?: WorkspaceEditEntryMetadata,
  ): void

  Create a regular file.

  Parameters

  • uri: Uri

    Uri of the new file.

  • Optionaloptions: {
        contents?: Uint8Array<ArrayBufferLike> | DataTransferFile;
        ignoreIfExists?: boolean;
        overwrite?: 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. The content-property allows to set the initial contents the file is being created with.

    • Optional Readonlycontents?: Uint8Array<ArrayBufferLike> | DataTransferFile

      The initial contents of the new file.

      If creating a file from a drop operation, you can pass in a DataTransferFile to improve performance by avoiding extra data copying.

    • Optional ReadonlyignoreIfExists?: boolean

      Do nothing if a file with uri exists already.

    • Optional Readonlyoverwrite?: boolean

      Overwrite existing file. Overwrite wins over ignoreIfExists

  • Optionalmetadata: WorkspaceEditEntryMetadata

    Optional metadata for the entry.

  Returns void

delete

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

  Delete the text at the given range.

  Parameters

  • uri: Uri

    A resource identifier.

  • range: Range

    A range.

  • Optionalmetadata: WorkspaceEditEntryMetadata

    Optional metadata for the entry.

  Returns void

deleteFile

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

  Delete a file or folder.

  Parameters

  • uri: Uri

    The uri of the file that is to be deleted.

  • Optionaloptions: { ignoreIfNotExists?: boolean; recursive?: boolean }

    • Optional ReadonlyignoreIfNotExists?: boolean

      Do nothing if a file with uri exists already.

    • Optional Readonlyrecursive?: boolean

      Delete the content recursively if a folder is denoted.

  • Optionalmetadata: 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: 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: 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: Uri,
      position: Position,
      newText: string,
      metadata?: WorkspaceEditEntryMetadata,
  ): void

  Insert the given text at the given position.

  Parameters

  • uri: Uri

    A resource identifier.

  • position: Position

    A position.

  • newText: string

    A string.

  • Optionalmetadata: WorkspaceEditEntryMetadata

    Optional metadata for the entry.

  Returns void

renameFile

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

  Rename a file or folder.

  Parameters

  • oldUri: Uri

    The existing file.

  • newUri: Uri

    The new location.

  • Optionaloptions: { ignoreIfExists?: boolean; overwrite?: boolean }

    Defines if existing files should be overwritten or be ignored. When overwrite and ignoreIfExists are both set overwrite wins.

    • Optional ReadonlyignoreIfExists?: boolean

      Do nothing if a file with uri exists already.

    • Optional Readonlyoverwrite?: boolean

      Overwrite existing file. Overwrite wins over ignoreIfExists

  • Optionalmetadata: WorkspaceEditEntryMetadata

    Optional metadata for the entry.

  Returns void

replace

• replace(
      uri: Uri,
      range: Range,
      newText: string,
      metadata?: WorkspaceEditEntryMetadata,
  ): 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.

  • Optionalmetadata: WorkspaceEditEntryMetadata

    Optional metadata for the entry.

  Returns void

set

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

  Set (and replace) text edits or snippet edits for a resource.

  Parameters

  • uri: Uri

    A resource identifier.

  • edits: readonly (TextEdit | SnippetTextEdit)[]

    An array of edits.

  Returns void

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

  Set (and replace) text edits or snippet edits with metadata for a resource.

  Parameters

  • uri: Uri

    A resource identifier.

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

    An array of edits.

  Returns void

• set(uri: Uri, edits: readonly NotebookEdit[]): 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: Uri,
      edits: readonly [NotebookEdit, WorkspaceEditEntryMetadata | undefined][],
  ): void

  Set (and replace) notebook edits with metadata for a resource.

  Parameters

  • uri: Uri

    A resource identifier.

  • edits: readonly [NotebookEdit, WorkspaceEditEntryMetadata | undefined][]

    An array of edits.

  Returns void