Progress bar APIs for the command handler. Use these methods to start and end progress bars. Only one bar can be active at any given time. Progress bars are displayed at the users terminal/console (indicates/updates with progress) and are NOT shown

export
interface

  IHandlerProgressApi

### Hierarchy

- IHandlerProgressApi

## Index

### Methods

- endBar
- endSpinner
- startBar
- startSpinner

## Methods

### endBar

- endBar(): void

- - Defined in @zowe/imperative/src/cmd/src/doc/response/api/handler/IHandlerProgressApi.ts:31

  Ends an outstanding progress bar (does nothing if no progress bars have been started).

  memberof

    IHandlerProgressApi

  #### Returns void

### Optional endSpinner

- endSpinner(endText?: string): void

- - Defined in @zowe/imperative/src/cmd/src/doc/response/api/handler/IHandlerProgressApi.ts:43

  Stop a spinner - displays on the users terminal

  memberof

    IHandlerProgressApi

  #### Parameters

  - ##### Optional endText: string

  #### Returns void

### startBar

- startBar(params: IProgressBarParms): void

- - Defined in @zowe/imperative/src/cmd/src/doc/response/api/handler/IHandlerProgressApi.ts:26

  Start a progress bar - displays on the users terminal. Only one progress bar can be active at any given time.

  memberof

    IHandlerProgressApi

  #### Parameters

  - ##### params: IProgressBarParms

    See the interface for details.

  #### Returns void

### Optional startSpinner

- startSpinner(pendingText: string): void

- - Defined in @zowe/imperative/src/cmd/src/doc/response/api/handler/IHandlerProgressApi.ts:37

  Start a spinner - displays on the users terminal

  memberof

    IHandlerProgressApi

  #### Parameters

  - ##### pendingText: string

  #### Returns void

Generated using TypeDoc