Class SdtdConnectionInfo

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)

Constructors

constructor

Properties

adminToken adminUser host useCPM useLegacy useTls

Methods

toJSON validate

Constructors

constructor

Properties

ReadonlyadminToken

adminToken: string

ReadonlyadminUser

adminUser: string

Readonlyhost

host: string

ReadonlyuseCPM

useCPM: boolean

ReadonlyuseLegacy

useLegacy: boolean

ReadonlyuseTls

useTls: boolean

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