Class FirstSuitableConverter<TInput, TOutput>

Converter that converts a value of type "TInput" to a value of type "TOutput" using the first suitable converter from a list of converters.

Type Parameters

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

Hierarchy (View Summary)

Converter<TInput, TOutput>
- FirstSuitableConverter

Index

Constructors

Properties

Methods

canConvert convert findFirstSuitableConverter getConverters getReverseConverter throwConversionError

Constructors

constructor

new FirstSuitableConverter<TInput, TOutput>(
converters: Converter<TInput, TOutput>[],
): FirstSuitableConverter<TInput, TOutput>
Constructor that initializes the FirstSuitableConverter with an array of converters.
Type Parameters
- TInput
  The type of the input value.
- TOutput
  The type of the output value.
Parameters
- converters: Converter<TInput, TOutput>[]
  An array of converters to use for conversion.
Returns FirstSuitableConverter<TInput, TOutput>
Overrides Converter.constructor
- Defined in src/common/converters/FirstSuitableConverter.ts:22

Properties

`Protected`converters

converters: Converter<TInput, TOutput>[]

Array of converters to use for conversion.

Methods

canConvert

canConvert(value: TInput): boolean
Checks if the given value can be converted by any of the converters in the list.
Parameters
- value: TInput
  The value to check.
Returns boolean
True if the value can be converted, false otherwise.
Overrides Converter.canConvert
- Defined in src/common/converters/FirstSuitableConverter.ts:62

convert

convert(value: TInput): TOutput
Converts a value of type "TInput" to a value of type "TOutput" using the first suitable converter from the list.
Parameters
- value: TInput
  The value to convert.
Returns TOutput
The converted value.

Throws
ConversionError - If the value cannot be converted.
Overrides Converter.convert
- Defined in src/common/converters/FirstSuitableConverter.ts:48

`Protected`findFirstSuitableConverter

findFirstSuitableConverter(value: TInput): null | Converter<TInput, TOutput>
Finds the first suitable converter for the given value from the list of converters.
Parameters
- value: TInput
  The value to check.
Returns null | Converter<TInput, TOutput>
The first suitable converter if found, otherwise null.
- Defined in src/common/converters/FirstSuitableConverter.ts:82

getConverters

getConverters(): Converter<TInput, TOutput>[]
Returns the list of converters used by this FirstSuitableConverter.

Returns Converter<TInput, TOutput>[]
An array of converters.
- Defined in src/common/converters/FirstSuitableConverter.ts:72

getReverseConverter

getReverseConverter(): FirstSuitableConverter<TOutput, TInput>
Returns the reverse converter for this converter. Creates a new instance of FirstSuitableConverter with the reverse converters of each converter in the list.

Returns FirstSuitableConverter<TOutput, TInput>
Overrides Converter.getReverseConverter
- Defined in src/common/converters/FirstSuitableConverter.ts:31

`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.
Inherited from Converter.throwConversionError
- Defined in src/common/converters/Converter.ts:39