Class ICommandArgument

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<ICommandArgument>
- ICommandArgument

Index

Constructors

Properties

defaultValue? helpText? name position? type

Methods

toJSON validate

Constructors

constructor

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

Properties

`Optional`defaultValue

defaultValue?: string | null

`Optional`helpText

helpText?: string

name

name: string

`Optional`position

position?: number

type

type: string

Methods

toJSON

toJSON(optionOverrides?: ClassTransformOptions): Record<string, any>
Parameters
- OptionaloptionOverrides: ClassTransformOptions
Returns Record<string, any>
Inherited from TakaroDTO.toJSON
- Defined in lib-util/dist/TakaroDTO.d.ts:21

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:20