A promise object that also can be tracked for progress bars/ GUIS

### Type parameters

- #### T

### Hierarchy

- Promise<T>
  - IPromiseWithProgress

## Index

### Properties

- Promise
- [Symbol.toStringTag]
- progress

### Methods

- catch
- finally
- then

## Properties

### Promise

Promise: PromiseConstructor

- Defined in typescript/lib/lib.es2015.promise.d.ts:150

### Readonly [Symbol.toStringTag]

[Symbol.toStringTag]: string

Inherited from IPromiseWithProgress.[Symbol.toStringTag]

- Defined in typescript/lib/lib.es2015.symbol.wellknown.d.ts:169

### progress

progress: ITaskWithStatus

- Defined in @zowe/imperative/src/operations/src/doc/ITaskWithStatus.ts:38

## Methods

### catch

- catch<TResult>(onrejected?: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null): Promise<T | TResult>

- Inherited from IPromiseWithProgress.catch

  - Defined in typescript/lib/lib.es5.d.ts:1430

  Attaches a callback for only the rejection of the Promise.

  #### Type parameters

  - #### TResult = never

  #### Parameters

  - ##### Optional onrejected: ((reason: any) => TResult | PromiseLike<TResult>) | undefined | null

    The callback to execute when the Promise is rejected.

  #### Returns Promise<T | TResult>

  A Promise for the completion of the callback.

### finally

- finally(onfinally?: (() => void) | undefined | null): Promise<T>

- Inherited from IPromiseWithProgress.finally

  - Defined in typescript/lib/lib.es2018.promise.d.ts:31

  Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The resolved value cannot be modified from the callback.

  #### Parameters

  - ##### Optional onfinally: (() => void) | undefined | null

    The callback to execute when the Promise is settled (fulfilled or rejected).

  #### Returns Promise<T>

  A Promise for the completion of the callback.

### then

- then<TResult1, TResult2>(onfulfilled?: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>

- Inherited from IPromiseWithProgress.then

  - Defined in typescript/lib/lib.es5.d.ts:1423

  Attaches callbacks for the resolution and/or rejection of the Promise.

  #### Type parameters

  - #### TResult1 = T

  - #### TResult2 = never

  #### Parameters

  - ##### Optional onfulfilled: ((value: T) => TResult1 | PromiseLike<TResult1>) | undefined | null

    The callback to execute when the Promise is resolved.

  - ##### Optional onrejected: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null

    The callback to execute when the Promise is rejected.

  #### Returns Promise<TResult1 | TResult2>

  A Promise for the completion of which ever callback is executed.

Generated using TypeDoc