@fgv/ts-utils 3.0.0 → 3.0.1-alpha.1

package/lib/packlets/conversion/converters.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.transformObject = exports.transform = exports.discriminatedObject = exports.strictObject = exports.object = exports.optionalField = exports.field = exports.optionalElement = exports.element = exports.validateWith = exports.mapOf = exports.recordOf = exports.numberArray = exports.stringArray = exports.arrayOf = exports.oneOf = exports.optionalBoolean = exports.optionalNumber = exports.isA = exports.validated = exports.isoDate = exports.delimitedString = exports.optionalString = exports.boolean = exports.number = exports.value = exports.literal = exports.mappedEnumeratedValue = exports.enumeratedValue = exports.templateString = exports.string = void 0;
 const base_1 = require("../base");
-const converter_1 = require("./converter");
+const baseConverter_1 = require("./baseConverter");
 const objectConverter_1 = require("./objectConverter");
 const stringConverter_1 = require("./stringConverter");
 const luxon_1 = require("luxon");
@@ -44,7 +44,7 @@ exports.string = new stringConverter_1.StringConverter();
  * @remarks
  * Template conversions are applied using `mustache` syntax.
  * @param defaultContext - Optional default context to use for template values.
- * @returns A new {@link Converter} returning `string`.
+ * @returns A new {@link Converter | Converter} returning `string`.
  * @public
  */
 function templateString(defaultContext) {
@@ -57,17 +57,17 @@ function templateString(defaultContext) {
 }
 exports.templateString = templateString;
 /**
- * Helper function to create a {@link Converter} which converts `unknown` to one of a set of supplied
+ * Helper function to create a {@link Converter | Converter} which converts `unknown` to one of a set of supplied
  * enumerated values. Anything else fails.
  *
  * @remarks
  * Allowed enumerated values can also be supplied as context at conversion time.
  * @param values - Array of allowed values.
- * @returns A new {@link Converter} returning `<T>`.
+ * @returns A new {@link Converter | Converter} returning `<T>`.
  * @public
  */
 function enumeratedValue(values) {
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         const v = context !== null && context !== void 0 ? context : values;
         const index = v.indexOf(from);
         return index >= 0 ? (0, base_1.succeed)(v[index]) : (0, base_1.fail)(`Invalid enumerated value ${JSON.stringify(from)}`);
@@ -75,7 +75,7 @@ function enumeratedValue(values) {
 }
 exports.enumeratedValue = enumeratedValue;
 /**
- * Helper function to create a {@link Converter} which converts `unknown` to one of a set of supplied enumerated
+ * Helper function to create a {@link Converter | Converter} which converts `unknown` to one of a set of supplied enumerated
  * values, mapping any of multiple supplied values to the enumeration.
  * @remarks
  * Enables mapping of multiple input values to a consistent internal representation (so e.g. `'y'`, `'yes'`,
@@ -84,11 +84,11 @@ exports.enumeratedValue = enumeratedValue;
  * value, the second is the set of values that map to the result.  Tuples are evaluated in the order
  * supplied and are not checked for duplicates.
  * @param message - An optional error message.
- * @returns A {@link Converter} which applies the mapping and yields `<T>` on success.
+ * @returns A {@link Converter | Converter} which applies the mapping and yields `<T>` on success.
  * @public
  */
 function mappedEnumeratedValue(map, message) {
-    return new converter_1.BaseConverter((from, __self, __context) => {
+    return new baseConverter_1.BaseConverter((from, __self, __context) => {
         for (const item of map) {
             if (item[1].includes(from)) {
                 return (0, base_1.succeed)(item[0]);
@@ -101,14 +101,14 @@ function mappedEnumeratedValue(map, message) {
 }
 exports.mappedEnumeratedValue = mappedEnumeratedValue;
 /**
- * Helper function to create a {@link Converter} which converts `unknown` to some supplied literal value. Succeeds with
+ * Helper function to create a {@link Converter | Converter} which converts `unknown` to some supplied literal value. Succeeds with
  * the supplied value if an identity comparison succeeds, fails otherwise.
  * @param value - The value to be compared.
- * @returns A {@link Converter} which returns the supplied value on success.
+ * @returns A {@link Converter | Converter} which returns the supplied value on success.
  * @public
  */
 function literal(value) {
-    return new converter_1.BaseConverter((from, __self, __context) => {
+    return new baseConverter_1.BaseConverter((from, __self, __context) => {
         return from === value
             ? (0, base_1.succeed)(value)
             : (0, base_1.fail)(`${JSON.stringify(from)}: does not match ${JSON.stringify(value)}`);
@@ -124,12 +124,12 @@ exports.literal = literal;
 // eslint-disable-next-line @rushstack/typedef-var
 exports.value = literal;
 /**
- * A {@link Converter} which converts `unknown` to a `number`.
+ * A {@link Converter | Converter} which converts `unknown` to a `number`.
  * @remarks
  * Numbers and strings with a numeric format succeed. Anything else fails.
  * @public
  */
-exports.number = new converter_1.BaseConverter((from) => {
+exports.number = new baseConverter_1.BaseConverter((from) => {
     if (typeof from !== 'number') {
         const num = typeof from === 'string' ? Number(from) : NaN;
         return isNaN(num) ? (0, base_1.fail)(`Not a number: ${JSON.stringify(from)}`) : (0, base_1.succeed)(num);
@@ -137,13 +137,13 @@ exports.number = new converter_1.BaseConverter((from) => {
     return (0, base_1.succeed)(from);
 });
 /**
- * A {@link Converter} which converts `unknown` to `boolean`.
+ * A {@link Converter | Converter} which converts `unknown` to `boolean`.
  * @remarks
  * Boolean values or the case-insensitive strings `'true'` and `'false'` succeed.
  * Anything else fails.
  * @public
  */
-exports.boolean = new converter_1.BaseConverter((from) => {
+exports.boolean = new baseConverter_1.BaseConverter((from) => {
     if (typeof from === 'boolean') {
         return (0, base_1.succeed)(from);
     }
@@ -158,22 +158,22 @@ exports.boolean = new converter_1.BaseConverter((from) => {
     return (0, base_1.fail)(`Not a boolean: ${JSON.stringify(from)}`);
 });
 /**
- * A {@link Converter} which converts an optional `string` value. Values of type
- * `string` are returned.  Anything else returns {@link Success} with value `undefined`.
+ * A {@link Converter | Converter} which converts an optional `string` value. Values of type
+ * `string` are returned.  Anything else returns {@link Success | Success} with value `undefined`.
  * @public
  */
 exports.optionalString = exports.string.optional();
 /**
- * Helper function to create a {@link Converter} which converts any `string` into an
+ * Helper function to create a {@link Converter | Converter} which converts any `string` into an
  * array of `string`, by separating at a supplied delimiter.
  * @remarks
  * Delimiter may also be supplied as context at conversion time.
  * @param delimiter - The delimiter at which to split.
- * @returns A new {@link Converter} returning `string[]`.
+ * @returns A new {@link Converter | Converter} returning `string[]`.
  * @public
  */
 function delimitedString(delimiter, options = 'filtered') {
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         const result = exports.string.convert(from);
         if (result.isSuccess()) {
             let strings = result.value.split(context !== null && context !== void 0 ? context : delimiter);
@@ -187,11 +187,11 @@ function delimitedString(delimiter, options = 'filtered') {
 }
 exports.delimitedString = delimitedString;
 /**
- * A {@link Converter} which converts an iso formatted string, a number or a `Date` object to
+ * A {@link Converter | Converter} which converts an iso formatted string, a number or a `Date` object to
  * a `Date` object.
  * @public
  */
-exports.isoDate = new converter_1.BaseConverter((from) => {
+exports.isoDate = new baseConverter_1.BaseConverter((from) => {
     if (typeof from === 'string') {
         const dt = luxon_1.DateTime.fromISO(from);
         if (dt.isValid) {
@@ -208,27 +208,27 @@ exports.isoDate = new converter_1.BaseConverter((from) => {
     return (0, base_1.fail)(`Cannot convert ${JSON.stringify(from)} to Date`);
 });
 /**
- * Helper function to create a {@link Converter} from any {@link Validation.Validator}
+ * Helper function to create a {@link Converter | Converter} from any {@link Validation.Validator}
  * @param validator - the validator to be wrapped
- * @returns A {@link Converter} which uses the supplied validator.
+ * @returns A {@link Converter | Converter} which uses the supplied validator.
  * @public
  */
 function validated(validator) {
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         return validator.validate(from, context);
     });
 }
 exports.validated = validated;
 /**
- * Helper function to create a {@link Converter} from a supplied type guard function.
+ * Helper function to create a {@link Converter | Converter} from a supplied type guard function.
  * @param description - a description of the thing to be validated for use in error messages
  * @param guard - a {@link Validation.TypeGuardWithContext} which performs the validation.
- * @returns A new {@link Converter} which validates the values using the supplied type guard
+ * @returns A new {@link Converter | Converter} which validates the values using the supplied type guard
  * and returns them in place.
  * @public
  */
 function isA(description, guard) {
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         if (guard(from, context)) {
             return (0, base_1.succeed)(from);
         }
@@ -237,40 +237,42 @@ function isA(description, guard) {
 }
 exports.isA = isA;
 /**
- * A {@link Converter} which converts an optional `number` value.
+ * A {@link Converter | Converter} which converts an optional `number` value.
  * @remarks
  * Values of type `number` or numeric strings are converted and returned.
- * Anything else returns {@link Success} with value `undefined`.
+ * Anything else returns {@link Success | Success} with value `undefined`.
  * @public
  */
 exports.optionalNumber = exports.number.optional();
 /**
- * A {@link Converter} to convert an optional `boolean` value.
+ * A {@link Converter | Converter} to convert an optional `boolean` value.
  * @remarks
  * Values of type `boolean` or strings that match (case-insensitive) `'true'`
- * or `'false'` are converted and returned.  Anything else returns {@link Success}
+ * or `'false'` are converted and returned.  Anything else returns {@link Success | Success}
  * with value `undefined`.
  * @public
  */
 exports.optionalBoolean = exports.boolean.optional();
 /**
- * A helper function to create a {@link Converter} for polymorphic values.  Returns a
- * converter which Invokes the wrapped converters in sequence, returning the first successful
- * result.  Returns an error if none of the supplied converters can convert the value.
+ * A helper function to create a {@link Converter | Converter} for polymorphic values.
+ * Returns a converter which invokes the wrapped converters in sequence, returning the
+ * first successful result.  Returns an error if none of the supplied converters can
+ * convert the value.
  * @remarks
  * If `onError` is `ignoreErrors` (default), then errors from any of the
  * converters are ignored provided that some converter succeeds.  If
  * onError is `failOnError`, then an error from any converter fails the entire
  * conversion.
  *
- * @param converters - An ordered list of {@link Converter | converters} to be considered.
+ * @param converters - An ordered list of {@link Converter | converters} or {@link Validator | validators}
+ * to be considered.
  * @param onError - Specifies treatment of unconvertible elements.
- * @returns A new {@link Converter} which yields a value from the union of the types returned
+ * @returns A new {@link Converter | Converter} which yields a value from the union of the types returned
  * by the wrapped converters.
  * @public
  */
 function oneOf(converters, onError = 'ignoreErrors') {
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         const errors = [];
         for (const converter of converters) {
             const result = converter.convert(from, context);
@@ -289,17 +291,18 @@ function oneOf(converters, onError = 'ignoreErrors') {
 }
 exports.oneOf = oneOf;
 /**
- * A helper function to create a {@link Converter} which converts `unknown` to an array of `<T>`.
+ * A helper function to create a {@link Converter | Converter} which converts `unknown` to an array of `<T>`.
  * @remarks
  * If `onError` is `'failOnError'` (default), then the entire conversion fails if any element cannot
  * be converted.  If `onError` is `'ignoreErrors'`, then failing elements are silently ignored.
- * @param converter - {@link Converter} used to convert each item in the array.
+ * @param converter - {@link Converter | Converter} or {@link Validator | Validator} used to convert each
+ * item in the array.
  * @param ignoreErrors - Specifies treatment of unconvertible elements.
- * @returns A {@link Converter} which returns an array of `<T>`.
+ * @returns A {@link Converter | Converter} which returns an array of `<T>`.
  * @public
  */
 function arrayOf(converter, onError = 'failOnError') {
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         if (!Array.isArray(from)) {
             return (0, base_1.fail)(`Not an array: ${JSON.stringify(from)}`);
         }
@@ -319,10 +322,10 @@ function arrayOf(converter, onError = 'failOnError') {
 }
 exports.arrayOf = arrayOf;
 /**
- * {@link Converter} to convert an `unknown` to an array of `string`.
+ * {@link Converter | Converter} to convert an `unknown` to an array of `string`.
  * @remarks
- * Returns {@link Success} with the the supplied value if it as an array
- * of strings, returns {@link Failure} with an error message otherwise.
+ * Returns {@link Success | Success} with the the supplied value if it as an array
+ * of strings, returns {@link Failure | Failure} with an error message otherwise.
  * @public
  */
 exports.stringArray = arrayOf(exports.string);
@@ -342,7 +345,7 @@ exports.numberArray = arrayOf(exports.number);
  */
 function recordOf(converter, option = 'fail') {
     const options = typeof option === 'string' ? { onError: option } : Object.assign({ onError: 'fail' }, option);
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         var _a, _b;
         if (typeof from !== 'object' || from === null || Array.isArray(from)) {
             return (0, base_1.fail)(`Not a string-keyed object: ${JSON.stringify(from)}`);
@@ -377,7 +380,7 @@ exports.recordOf = recordOf;
  */
 function mapOf(converter, option = 'fail') {
     const options = typeof option === 'string' ? { onError: option } : Object.assign({ onError: 'fail' }, option);
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         var _a, _b;
         if (typeof from !== 'object' || from === null || Array.isArray(from)) {
             return (0, base_1.fail)(`Not a string-keyed object: ${JSON.stringify(from)}`);
@@ -405,11 +408,11 @@ function mapOf(converter, option = 'fail') {
 }
 exports.mapOf = mapOf;
 /**
- * Helper function to create  a {@link Converter} which validates that a supplied value is
+ * Helper function to create  a {@link Converter | Converter} which validates that a supplied value is
  * of a type validated by a supplied validator function and returns it.
  * @remarks
- * If `validator` succeeds, this {@link Converter} returns {@link Success} with the supplied
- * value of `from` coerced to type `<T>`.  Returns a {@link Failure} with additional
+ * If `validator` succeeds, this {@link Converter | Converter} returns {@link Success | Success} with the supplied
+ * value of `from` coerced to type `<T>`.  Returns a {@link Failure | Failure} with additional
  * information otherwise.
  * @param validator - A validator function to determine if the converted value is valid.
  * @param description - A description of the validated type for use in error messages.
@@ -417,7 +420,7 @@ exports.mapOf = mapOf;
  * @public
  */
 function validateWith(validator, description) {
-    return new converter_1.BaseConverter((from, __self, __context) => {
+    return new baseConverter_1.BaseConverter((from, __self, __context) => {
         if (validator(from)) {
             return (0, base_1.succeed)(from);
         }
@@ -426,17 +429,17 @@ function validateWith(validator, description) {
 }
 exports.validateWith = validateWith;
 /**
- * A helper function to create a {@link Converter} which extracts and converts an element from an array.
+ * A helper function to create a {@link Converter | Converter} which extracts and converts an element from an array.
  * @remarks
- * The returned {@link Converter} returns {@link Success} with the converted value if the element exists
- * in the supplied array and can be converted. Returns {@link Failure} with an error message otherwise.
+ * The returned {@link Converter | Converter} returns {@link Success | Success} with the converted value if the element exists
+ * in the supplied array and can be converted. Returns {@link Failure | Failure} with an error message otherwise.
  * @param index - The index of the element to be extracted.
- * @param converter - A {@link Converter} used to convert the extracted element.
+ * @param converter - A {@link Converter | Converter} or {@link Validator | Validator} for the extracted element.
  * @returns A {@link Converter | Converter<T>} which extracts the specified element from an array.
  * @public
  */
 function element(index, converter) {
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         if (index < 0) {
             return (0, base_1.fail)(`${index}: cannot convert for a negative element index`);
         }
@@ -451,19 +454,19 @@ function element(index, converter) {
 }
 exports.element = element;
 /**
- * A helper function to create a {@link Converter} which extracts and converts an optional element from an array.
+ * A helper function to create a {@link Converter | Converter} which extracts and converts an optional element from an array.
  * @remarks
- * The resulting {@link Converter} returns {@link Success} with the converted value if the element exists
- * in the supplied array and can be converted. Returns {@link Success} with value `undefined` if the parameter
- * is an array but the index is out of range. Returns {@link Failure} with a message if the supplied parameter
+ * The resulting {@link Converter | Converter} returns {@link Success | Success} with the converted value if the element exists
+ * in the supplied array and can be converted. Returns {@link Success | Success} with value `undefined` if the parameter
+ * is an array but the index is out of range. Returns {@link Failure | Failure} with a message if the supplied parameter
  * is not an array, if the requested index is negative, or if the element cannot be converted.
  * @param index - The index of the element to be extracted.
- * @param converter - A {@link Converter} used to convert the extracted element.
+ * @param converter - A {@link Converter | Converter} or {@link Validator | Validator} used for the extracted element.
  * @returns A {@link Converter | Converter<T>} which extracts the specified element from an array.
  * @public
  */
 function optionalElement(index, converter) {
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         if (index < 0) {
             return (0, base_1.fail)(`${index}: cannot convert for a negative element index`);
         }
@@ -478,18 +481,19 @@ function optionalElement(index, converter) {
 }
 exports.optionalElement = optionalElement;
 /**
- * A helper function to create a {@link Converter} which extracts and convert a property specified
+ * A helper function to create a {@link Converter | Converter} which extracts and convert a property specified
  * by name from an object.
  * @remarks
- * The resulting {@link Converter} returns {@link Success} with the converted value of the corresponding
- * object property if the field exists and can be converted. Returns {@link Failure} with an error message
+ * The resulting {@link Converter | Converter} returns {@link Success | Success} with the converted value of the corresponding
+ * object property if the field exists and can be converted. Returns {@link Failure | Failure} with an error message
  * otherwise.
  * @param name - The name of the field to be extracted.
- * @param converter - {@link Converter} used to convert the extracted field.
+ * @param converter - {@link Converter | Converter}  or {@link Validator | Validator} to use for the extracted
+ * field.
  * @public
  */
 function field(name, converter) {
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         if (typeof from === 'object' && !Array.isArray(from) && from !== null) {
             if ((0, base_1.isKeyOf)(name, from)) {
                 return converter.convert(from[name], context).onFailure((message) => {
@@ -503,19 +507,19 @@ function field(name, converter) {
 }
 exports.field = field;
 /**
- * A helper function to create a {@link Converter} which extracts and convert a property specified
+ * A helper function to create a {@link Converter | Converter} which extracts and convert a property specified
  * by name from an object.
  * @remarks
- * The resulting {@link Converter} returns {@link Success} with the converted value of the corresponding
- * object property if the field exists and can be converted. Returns {@link Success} with value `undefined`
- * if the supplied parameter is an object but the named field is not present.  Returns {@link Failure} with
- * an error message otherwise.
+ * The resulting {@link Converter | Converter} returns {@link Success | Success} with the converted value of
+ * the corresponding object property if the field exists and can be converted. Returns {@link Success | Success}
+ * with `undefined` if the supplied parameter is an object but the named field is not present.
+ * Returns {@link Failure | Failure} with an error message otherwise.
  * @param name - The name of the field to be extracted.
- * @param converter - {@link Converter} used to convert the extracted field.
+ * @param converter - {@link Converter | Converter} or {@link Validator | Validator} to use for the extracted field.
  * @public
  */
 function optionalField(name, converter) {
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         if (typeof from === 'object' && !Array.isArray(from) && from !== null) {
             if ((0, base_1.isKeyOf)(name, from)) {
                 const result = converter.convert(from[name], context).onFailure((message) => {
@@ -554,23 +558,23 @@ function strictObject(properties, opt) {
 }
 exports.strictObject = strictObject;
 /**
- * Helper to create a {@link Converter} which converts a discriminated object without changing shape.
+ * Helper to create a {@link Converter | Converter} which converts a discriminated object without changing shape.
  * @remarks
  * Takes the name of the discriminator property and a
- * {@link Converters.DiscriminatedObjectConverters | string-keyed Record of converters}. During conversion,
- * the resulting {@link Converter} invokes the converter from `converters` that corresponds to the value of
+ * {@link Converters.DiscriminatedObjectConverters | string-keyed Record of converters and validators}. During conversion,
+ * the resulting {@link Converter | Converter} invokes the converter from `converters` that corresponds to the value of
  * the discriminator property in the source object.
  *
  * If the source is not an object, the discriminator property is missing, or the discriminator has
- * a value not present in the converters, conversion fails and returns {@link Failure} with more information.
+ * a value not present in the converters, conversion fails and returns {@link Failure | Failure} with more information.
  * @param discriminatorProp - Name of the property used to discriminate types.
- * @param converters - {@link Converters.DiscriminatedObjectConverters | String-keyed record of converters} to
- * invoke, where each key corresponds to a value of the discriminator property.
- * @returns A {@link Converter} which converts the corresponding discriminated object.
+ * @param converters - {@link Converters.DiscriminatedObjectConverters | String-keyed record of converters and validators}
+ * to invoke, where each key corresponds to a value of the discriminator property.
+ * @returns A {@link Converter | Converter} which converts the corresponding discriminated object.
  * @public
  */
 function discriminatedObject(discriminatorProp, converters) {
-    return new converter_1.BaseConverter((from) => {
+    return new baseConverter_1.BaseConverter((from) => {
         if (typeof from !== 'object' || Array.isArray(from) || from === null) {
             return (0, base_1.fail)(`Not a discriminated object: "${JSON.stringify(from)}"`);
         }
@@ -587,13 +591,13 @@ function discriminatedObject(discriminatorProp, converters) {
 }
 exports.discriminatedObject = discriminatedObject;
 /**
- * Helper to create a {@link Converter} which converts a source object to a new object with a
+ * Helper to create a {@link Converter | Converter} which converts a source object to a new object with a
  * different shape.
  *
  * @remarks
- * On successful conversion, the resulting {@link Converter} returns {@link Success} with a new
+ * On successful conversion, the resulting {@link Converter | Converter} returns {@link Success | Success} with a new
  * object, which contains the converted values under the key names specified at initialization time.
- * It returns {@link Failure} with an error message if any fields to be extracted do not exist
+ * It returns {@link Failure | Failure} with an error message if any fields to be extracted do not exist
  * or cannot be converted.
  *
  * Fields that succeed but convert to undefined are omitted from the result object but do not
@@ -602,11 +606,11 @@ exports.discriminatedObject = discriminatedObject;
  * @param properties - An object with key names that correspond to the target object and an
  * appropriate {@link Conversion.FieldConverters | FieldConverter} which extracts and converts
  * a single filed from the source object.
- * @returns A {@link Converter} with the specified conversion behavior.
+ * @returns A {@link Converter | Converter} with the specified conversion behavior.
  * @public
  */
 function transform(properties) {
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         // eslint bug thinks key is used before defined
         // eslint-disable-next-line no-use-before-define
         const converted = {};
@@ -627,27 +631,27 @@ function transform(properties) {
 }
 exports.transform = transform;
 /**
- * Helper to create a strongly-typed {@link Converter} which converts a source object to a
+ * Helper to create a strongly-typed {@link Converter | Converter} which converts a source object to a
  * new object with a different shape.
  *
  * @remarks
- * On successful conversion, the resulting {@link Converter} returns {@link Success} with a new
+ * On successful conversion, the resulting {@link Converter | Converter} returns {@link Success | Success} with a new
  * object, which contains the converted values under the key names specified at initialization time.
  *
- * It returns {@link Failure} with an error message if any fields to be extracted do not exist
+ * It returns {@link Failure | Failure} with an error message if any fields to be extracted do not exist
  * or cannot be converted.
  *
  * @param destinationFields - An object with key names that correspond to the target object and an
  * appropriate {@link Converters.FieldTransformers | FieldTransformers} which specifies the name
- * of the corresponding property in the source object, the converter used to convert the source
- * property and any configuration to guide the conversion.
+ * of the corresponding property in the source object, the converter or validator used for each source
+ * property and any other configuration to guide the conversion.
  * @param options - Options which affect the transformation.
  *
- * @returns A {@link Converter} with the specified conversion behavior.
+ * @returns A {@link Converter | Converter} with the specified conversion behavior.
  * @public
  */
 function transformObject(destinationFields, options) {
-    return new converter_1.BaseConverter((from, __self, context) => {
+    return new baseConverter_1.BaseConverter((from, __self, context) => {
         // eslint bug thinks key is used before defined
         // eslint-disable-next-line no-use-before-define
         const converted = {};