Class ModuleTransferVersionDTO<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)

Constructors

constructor

Properties

commands? configSchema cronJobs? description functions? hooks? permissions? tag uiSchema

Methods

toJSON validate

Constructors

constructor

Properties

Optionalcommands

commands?: ICommand[]

configSchema

configSchema: string

OptionalcronJobs

cronJobs?: ICronJob[]

description

description: string

Optionalfunctions

functions?: IFunction[]

Optionalhooks

hooks?: IHook[]

Optionalpermissions

permissions?: IPermission[]

tag

tag: string

uiSchema

uiSchema: string = '{}'

Methods

toJSON

  • toJSON(): Record<string, any>

    Returns Record<string, any>

validate

  • validate(extraOpts?: ValidatorOptions): Promise<void>

    Validates the DTO instance

    Parameters

    • OptionalextraOpts: ValidatorOptions

    Returns Promise<void>

    Throws

    if validation fails

Settings

Member Visibility

On This Page

Constructors
Properties
Methods