Class RustConnectionInfo

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

Index

Constructors

Properties

host rconPassword rconPort useTls

Methods

toJSON validate

Constructors

constructor

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

Properties

`Readonly`host

host: string

`Readonly`rconPassword

rconPassword: string

`Readonly`rconPort

rconPort: string

`Readonly`useTls

useTls: boolean

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