Interface Progress

Hierarchy

Progress

Index

Properties

Methods

Properties

Readonly id

id: string

Unique progress id.

Readonly result

result: Promise<undefined | string>

Result of the progress.

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

Methods

Readonly cancel

cancel(): void

- Defined in packages/core/src/common/message-service-protocol.ts:95
Cancel or complete the current progress.

Returns void

Readonly report

report(update: ProgressUpdate): void

- Defined in packages/core/src/common/message-service-protocol.ts:91
Update the current progress.

Parameters
- update: ProgressUpdate
  
  the data to update.
Returns void