Class ProgressService

Hierarchy

ProgressService

Index

Constructors

constructor

Properties

Methods

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

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

Protected shouldDelegate

shouldDelegate(message: ProgressMessage): boolean

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

showProgress

showProgress(message: ProgressMessage, onDidCancel?: (() => void)): Promise<Progress>

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

withProgress

withProgress<T>(text: string, locationId: string, task: (() => Promise<T>), onDidCancel?: (() => void)): Promise<T>

- Defined in packages/core/src/common/progress-service.ts:74
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>