Class TestReachabilityOutputDTO

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

Index

Constructors

Properties

connectable latency? reason?

Methods

toJSON validate

Constructors

constructor

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

Properties

connectable

connectable: boolean

`Optional`latency

latency?: number

`Optional`reason

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