Theia API Documentation v1.66.0
    Preparing search index...

    Function updateWorkspaceFolders

    • This method replaces deleteCount workspace folders starting at index start by an optional set of workspaceFoldersToAdd on the theia.workspace.workspaceFolders array. This "splice" behavior can be used to add, remove and change workspace folders in a single operation.

      If the first workspace folder is added, removed or changed, the currently executing extensions (including the one that called this method) will be terminated and restarted so that the (deprecated) rootPath property is updated to point to the first workspace folder.

      Use the onDidChangeWorkspaceFolders() event to get notified when the workspace folders have been updated.

      Example: adding a new workspace folder at the end of workspace folders

      workspace.updateWorkspaceFolders(workspace.workspaceFolders ? workspace.workspaceFolders.length : 0, null, { uri: ...});

      Example: removing the first workspace folder

      workspace.updateWorkspaceFolders(0, 1);

      Example: replacing an existing workspace folder with a new one

      workspace.updateWorkspaceFolders(0, 1, { uri: ...});

      It is valid to remove an existing workspace folder and add it again with a different name to rename that folder.

      Note: it is not valid to call updateWorkspaceFolders() multiple times without waiting for the onDidChangeWorkspaceFolders() to fire.

      Parameters

      • start: number

        the zero-based location in the list of currently opened workspace folders from which to start deleting workspace folders.

      • deleteCount: undefined | null | number

        the optional number of workspace folders to remove.

      • ...workspaceFoldersToAdd: { name?: string; uri: Uri }[]

        the optional variable set of workspace folders to add in place of the deleted ones. Each workspace is identified with a mandatory URI and an optional name.

      Returns boolean

      true if the operation was successfully started and false otherwise if arguments were used that would result in invalid workspace folder state (e.g. 2 folders with the same URI).

    Settings

    Member Visibility