Class NOT_DOMAIN_SCOPED_TakaroModelDTO<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

Hierarchy (View Summary)

TakaroDTO<T>
- NOT_DOMAIN_SCOPED_TakaroModelDTO
  - TakaroModelDTO

Index

Constructors

Properties

createdAt id updatedAt

Methods

toJSON validate

Constructors

constructor

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

Properties

createdAt

createdAt: string

id

id: string

updatedAt

updatedAt: string

Methods

toJSON

toJSON(optionOverrides?: ClassTransformOptions): Record<string, any>
Parameters
- optionOverrides: ClassTransformOptions = {}
Returns Record<string, any>
Inherited from TakaroDTO.toJSON
- 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
Inherited from TakaroDTO.validate
- Defined in packages/lib-util/src/TakaroDTO.ts:27