Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Progress

Hierarchy

  • Progress

Index

Properties

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: ProgressUpdate) => void

Update the current progress.

param

the data to update.

Type declaration

Readonly result

result: Promise<undefined | string>

Result of the progress.

returns

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