Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ICommandResponseApi

Interface for the internal command processor response object, hides the fields that are required to fully build the response from the handlers.

export
interface

ICommandProcessorResponseApi

Hierarchy

  • ICommandResponseApi

Implemented by

Index

Properties

responseFormat

responseFormat: COMMAND_RESPONSE_FORMAT

Returns the response format that the object was constructed with - indicates how the output should be handled if response format is JSON, then data is buffered until the end and output at that time.

returns
  • The response format for this command.
memberof

ICommandProcessorResponseApi

silent

silent: boolean

If true, indicates that silent mode is enabled (no output whatsoever is produced by the response object)

returns
memberof

ICommandProcessorResponseApi

Methods

buildJsonResponse

endProgressBar

  • endProgressBar(): void

failed

  • failed(): void

setError

succeeded

  • succeeded(): void

writeJsonResponse

Generated using TypeDoc