The interface to the object passed to command handlers to formulate responses, print messages, etc. in their command processing. Handlers should never write directly to stdout/stderr.

export
interface

  ICommandResponseApi

### Hierarchy

- IHandlerResponseApi

### Implemented by

- HandlerResponse
- HandlerResponse

## Index

### Properties

- console
- data
- format
- progress

## Properties

### console

console: IHandlerResponseConsoleApi

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

Returns the console API object. Used for writing to stdout and stderr. Also buffers the stdout/stderr messages for population of the ultimate JSON response object.

returns
memberof

  IHandlerResponseApi

### data

data: IHandlerResponseDataApi

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

The response object is constructed for the purposes of responding to a command with JSON output. The response object houses additional fields and response areas for programmatic API usage of commands.

returns
memberof

  IHandlerResponseApi

### format

format: IHandlerFormatOutputApi

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

Format and output data according to the defaults specified (and optional overrides specified by the user). Use when printing/prettifying JSON objects/arrays (it can be used with string data, but string data does not benefit from the auto-formatting options). In conjunction with with ""

memberof

  IHandlerResponseApi

### progress

progress: IHandlerProgressApi

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

Apis to create and destroy progress bars during the command.

memberof

  IHandlerResponseApi

Generated using TypeDoc