Function doWithProgress

src/util.ts:299–312

(cb: (token?: vscode.CancellationToken, progress?: vscode.Progress<{ message?: string; increment?: number }>) => T | Promise<T>, location: (string | vscode.ProgressLocation) = vscode.ProgressLocation.Window, title?: string, cancellable?: boolean)

// synchronous callbacks are converted to async to properly render the progress bar
// default location is in the help pages tree view
export async function doWithProgress<T>(cb: (token?: vscode.CancellationToken, progress?: vscode.Progress<{ message?: string; increment?: number }>) => T | Promise<T>, location: (string | vscode.ProgressLocation) = vscode.ProgressLocation.Window, title?: string, cancellable?: boolean): Promise<T> {
    const location2 = (typeof location === 'string' ? { viewId: location } : location);
    const options: vscode.ProgressOptions = {
        location: location2,
        cancellable: cancellable ?? false,
        title: title
    };
    return await vscode.window.withProgress(options, async (progress, token) => {
        return await new Promise<T>((resolve) => setTimeout(() => {
            const ret = cb(token, progress);
            resolve(ret);
        }));
    });
}

// get the URL of a CRAN website
// argument path is optional and should be relative to the cran root