Class CommandOutput

Generic Data Transfer Object, used widely in Takaro to pass data back and forth between components Allows validation of properties when instantiated and JSON (de)serialization

Hierarchy (View Summary)

TakaroDTO<CommandOutput>
- CommandOutput

Index

Constructors

Properties

errorMessage? rawResult success

Methods

toJSON validate

Constructors

constructor

new CommandOutput(data?: Nullable<DeepPartial<CommandOutput>>): CommandOutput
Parameters
- Optionaldata: Nullable<DeepPartial<CommandOutput>>
Returns CommandOutput
Inherited from TakaroDTO.constructor
- Defined in lib-util/dist/TakaroDTO.d.ts:13

Properties

`Optional`errorMessage

errorMessage?: string

rawResult

rawResult: string

success

success: boolean

Methods

toJSON

toJSON(): Record<string, any>
Returns Record<string, any>
Inherited from TakaroDTO.toJSON
- Defined in lib-util/dist/TakaroDTO.d.ts:20

validate

validate(extraOpts?: ValidatorOptions): Promise<void>
Validates the DTO instance
Parameters
- OptionalextraOpts: ValidatorOptions
Returns Promise<void>
Throws
if validation fails
Inherited from TakaroDTO.validate
- Defined in lib-util/dist/TakaroDTO.d.ts:19