Class BuiltinModule<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 name permissions uiSchema

Methods

loadFn toJSON validate

Constructors

constructor

Properties

commands

commands: ICommand[] = []

configSchema

configSchema: string

cronJobs

cronJobs: ICronJob[] = []

description

description: string

functions

functions: IFunction[] = []

hooks

hooks: IHook[] = []

name

name: string

permissions

permissions: IPermission[] = []

uiSchema

uiSchema: string

Methods

ProtectedloadFn

  • loadFn(
        type: "commands" | "hooks" | "cronJobs" | "functions",
        name: string,
    ): string

  • Parameters

    • type: "commands" | "hooks" | "cronJobs" | "functions"
    • name: string

    Returns string

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