Class IHook

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

Index

Constructors

Properties

description? eventType function name regex?

Methods

toJSON validate

Constructors

constructor

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

Properties

`Optional`description

description?: string

eventType

eventType: EventTypes

function

function: string

name

name: string

`Optional`regex

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