Options
All
  • Public
  • Public/Protected
  • All
Menu

Class HandlerResponse

Handler command response APIs. Passed to command handlers for console messages, data responses, and progress bars. Handlers can implement their own logging scheme (or use the Imperative.api to obtain an instance of the logger), but handlers should NEVER write directly to the console and should always use the APIs here to construct responses. The HandlerResponse object will automatically handle response formats, etc.

export
implements

{IHandlerResponseApi}

Hierarchy

  • HandlerResponse

Implements

Index

Constructors

Properties

Accessors

Constructors

constructor

Properties

Private mApis

The command response object allocated by the command processor that exposes the APIs intended for the handler to use.

memberof

HandlerResponse

Accessors

console

data

format

progress

Generated using TypeDoc