Class TakaroEventModuleCreated

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)

BaseEvent<TakaroEventModuleCreated>
- TakaroEventModuleCreated

Index

Constructors

constructor

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

Properties

timestamp

timestamp: string = ...

type

type: "module-created" = TakaroEvents.MODULE_CREATED

Methods

toJSON

toJSON(optionOverrides?: ClassTransformOptions): Record<string, any>
Parameters
- OptionaloptionOverrides: ClassTransformOptions
Returns Record<string, any>
Inherited from BaseEvent.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 BaseEvent.validate
- Defined in lib-util/dist/TakaroDTO.d.ts:20

Class TakaroEventModuleCreated

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TakaroEventModuleCreated

Properties

timestamp

type

Methods

toJSON

Parameters

Returns Record<string, any>

validate

Parameters

Returns Promise<void>

Throws

Settings

On This Page