Class IItemDTO

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

Index

Constructors

Properties

amount? code description name quality?

Methods

toJSON validate

Constructors

constructor

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

Properties

`Optional`amount

amount?: number

code

code: string

description

description: string

name

name: string

`Optional`quality

quality?: 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