Class ProgressService

Index

Constructors

Properties

client counter messageService progressIdPrefix

Methods

newProgressId shouldDelegate showProgress withProgress

Constructors

constructor

new ProgressService(): ProgressService
Returns ProgressService

Properties

`Protected` `Readonly` client

client: ProgressClient

`Private` counter

counter: number = 0

`Protected` `Readonly` messageService

messageService: MessageService

`Private` progressIdPrefix

progressIdPrefix: string = ...

Methods

`Protected` newProgressId

newProgressId(): string
Returns string
- Defined in packages/core/src/common/progress-service.ts:70

`Protected` shouldDelegate

shouldDelegate(message): boolean
Parameters
- message: ProgressMessage
Returns boolean
- Defined in packages/core/src/common/progress-service.ts:63

showProgress

showProgress(message, onDidCancel?): Promise<Progress>
Parameters
- message: ProgressMessage
- Optional onDidCancel: (() => void)
  - - (): void
    - Returns void
Returns Promise<Progress>
- Defined in packages/core/src/common/progress-service.ts:33

withProgress

withProgress<T>(text, locationId, task, onDidCancel?): Promise<T>
Type Parameters
- T
Parameters
- text: string
- locationId: string
- task: (() => Promise<T>)
  - - (): Promise<T>
    - Returns Promise<T>
- Optional onDidCancel: (() => void)
  - - (): void
    - Returns void
Returns Promise<T>
- Defined in packages/core/src/common/progress-service.ts:74