Class TakaroEventFunctionResult

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

Index

Constructors

Properties

logs reason success tryAgainIn

Methods

toJSON validate

Constructors

constructor

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

Properties

logs

logs: TakaroEventFunctionLog[]

reason

reason: string

success

success: boolean

tryAgainIn

tryAgainIn: number

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