Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FileWillRenameEvent

An event that is fired when files are going to be renamed.

To make modifications to the workspace before the files are renamed, call the [`waitUntil](#FileWillCreateEvent.waitUntil)-function with a thenable that resolves to a workspace edit.

Hierarchy

  • FileWillRenameEvent

Index

Properties

Methods

Properties

Readonly files

files: readonly { newUri: Uri; oldUri: Uri }[]

The files that are going to be renamed.

Readonly token

token: CancellationToken

A cancellation token.

Methods

waitUntil

  • Allows to pause the event and to apply a workspace edit.

    Note: This function can only be called during event dispatch and not in an asynchronous manner:

    workspace.onWillCreateFiles(event => {
     // async, will *throw* an error
     setTimeout(() => event.waitUntil(promise));

     // sync, OK
     event.waitUntil(promise);
    })

    Parameters

    Returns void

  • Allows to pause the event until the provided thenable resolves.

    Note: This function can only be called during event dispatch.

    Parameters

    • thenable: Thenable<any>

      A thenable that delays saving.

    Returns void