Class Converter<TInput, TOutput>`Abstract`

Abstract base class for converters that convert values from one type to another.

Type Parameters

TInput
The type of the input value.
TOutput
The type of the output value.

Hierarchy (View Summary)

Converter

Index

Constructors

Methods

canConvert convert getReverseConverter throwConversionError

Constructors

constructor

new Converter<TInput, TOutput>(): Converter<TInput, TOutput>
Type Parameters
- TInput
- TOutput
Returns Converter<TInput, TOutput>

Methods

`Abstract`canConvert

canConvert(value: TInput): boolean
Checks if the given value can be converted by this converter.
Parameters
- value: TInput
  The value to check.
Returns boolean
True if the value can be converted, false otherwise.
- Defined in src/common/converters/Converter.ts:29

`Abstract`convert

convert(value: TInput): TOutput
Converts a value of type "TInput" to a value of type "TOutput".
Parameters
- value: TInput
  The value to convert.
Returns TOutput
The converted value of type "TOutput".
- Defined in src/common/converters/Converter.ts:21

`Abstract`getReverseConverter

getReverseConverter(): Converter<TOutput, TInput>
Returns the reverse converter for this converter.

Returns Converter<TOutput, TInput>
- Defined in src/common/converters/Converter.ts:13

`Protected`throwConversionError

throwConversionError(value: TInput): never
Throws a ConversionError for the given value.
Parameters
- value: TInput
  The value that caused the conversion error.
Returns never
never - This function does not return; it always throws an error.

Throws
ConversionError - An error indicating that the conversion failed.
- Defined in src/common/converters/Converter.ts:39