Interface Progress

interface Progress {
    cancel: (() => void);
    id: string;
    report: ((update) => void);
    result: Promise<undefined | string>;
}

Properties

cancel id report result

Properties

Readonly cancel

cancel: (() => void)

Cancel or complete the current progress.

Type declaration

    • (): void

    • Returns void

Readonly id

id: string

Unique progress id.

Readonly report

report: ((update) => void)

Update the current progress.

Type declaration

    • (update): void

    • Parameters

      Returns void

Readonly result

result: Promise<undefined | string>

Result of the progress.

Returns

a promise which resolves to either 'Cancel', an alternative action or undefined.

Settings

Member Visibility

Theme

On This Page

cancelidreportresult