The result for the conversion functions of DataTypeConverterService.

interface ConversionResult {
    value?: any;
    resolvedValue?: boolean;
    converter?: string;
    error?: Error;
    sourceLookupKey?: null | string;
    resultLookupKey?: string;
    earlierResult?: null | ConversionResult;
}

Properties

value?: any

The converted value. If conversion failed, return undefined. If the property is omitted, there was no conversion done.

resolvedValue?: boolean

Because undefined is a valid value to supply in value property, this property is used to indicate that the value was resolved. It is only true when a value has been determined, including undefined. NOTE: converter is similar, but does not get assigned in the case where the input value is null or undefined.

converter?: string

Name of the converter used. If no conversion was done, return undefined. There can be a converter when value = undefined.

error?: Error

An exception that was captured

sourceLookupKey?: null | string
resultLookupKey?: string
earlierResult?: null | ConversionResult

When conversion requires multiple steps and each with its own converter, this is a linked list of earlier results from the steps. The end node is the earliest result and has earlierResult = null. This value is always undefined when it ran out of converters before completing the request. This value is assigned when there is a value, or the last converter returned undefined.

Generated using TypeDoc v0.25.12