Class TakaroDTO<T>

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

Type Parameters

T

Index

Constructors

Methods

toJSON validate

Constructors

constructor

new TakaroDTO<T>(data?: Nullable<DeepPartial<T>>): TakaroDTO<T>
Type Parameters
- T
Parameters
- Optionaldata: Nullable<DeepPartial<T>>
Returns TakaroDTO<T>
- Defined in packages/lib-util/src/TakaroDTO.ts:18

Methods

toJSON

toJSON(optionOverrides?: ClassTransformOptions): Record<string, any>
Parameters
- optionOverrides: ClassTransformOptions = {}
Returns Record<string, any>
- Defined in packages/lib-util/src/TakaroDTO.ts:51

validate

validate(extraOpts?: ValidatorOptions): Promise<void>
Validates the DTO instance
Parameters
- extraOpts: ValidatorOptions = {}
Returns Promise<void>
Throws
if validation fails
- Defined in packages/lib-util/src/TakaroDTO.ts:27