Class ObjectToStringConverter<TInput, TOutput>

Converter that converts an object to a string representation.

Type Parameters

TInput extends object = object
The type of the input value; must extend object.
TOutput extends string = string
The type of the output value; must extend string.

Hierarchy (View Summary)

Converter<TInput, TOutput>
- ObjectToStringConverter

Index

Methods

canConvert convert getReverseConverter throwConversionError getInstance

Methods

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.
Overrides Converter.canConvert
- Defined in src/common/converters/ObjectToStringConverter.ts:63

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".

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

getReverseConverter

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

Returns StringToObjectConverter<TOutput, TInput>
Overrides Converter.getReverseConverter
- Defined in src/common/converters/ObjectToStringConverter.ts:38

`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

`Static`getInstance

getInstance<TInput extends object = object, TOutput extends string = string>(): ObjectToStringConverter<
TInput,
TOutput,
>
Returns the singleton instance of the ObjectToStringConverter.
Type Parameters
- TInput extends object = object
  The type of the input value; must extend object.
- TOutput extends string = string
  The type of the output value; must extend string.
Returns ObjectToStringConverter<TInput, TOutput>
The singleton instance of the ObjectToStringConverter.
- Defined in src/common/converters/ObjectToStringConverter.ts:24