@fgv/ts-utils 1.2.0-alpha.2 → 1.3.0

package/README.md

@@ -21,6 +21,7 @@ Also includes a few other much less-developed odds-and-ends borrowed from one pr
 
 - [Summary](#summary)
 - [Installation](#installation)
+- [API Documentation](#api-documentation)
 - [Overview](#overview)
   - [The Result Pattern](#the-result-pattern)
   - [Converters](#converters)
@@ -40,6 +41,9 @@ With npm:
 npm install ts-utils
 ```
 
+## API Documentation
+Extracted API documentation is [here](./docs/ts-utils.md).
+
 ## Overview
 ### The Result Pattern
 

package/brand.d.ts

@@ -1,6 +1,8 @@
 /**
  * Helper type to brand a simple type to prevent inappropriate use
+ * @public
  */
 export declare type Brand<T, B> = T & {
     __brand: B;
 };
+//# sourceMappingURL=brand.d.ts.map

package/brand.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brand.d.ts","sourceRoot":"","sources":["../src/brand.ts"],"names":[],"mappings":"AAsBA;;;GAGG;AAEH,oBAAY,KAAK,CAAC,CAAC,EAAE,CAAC,IAAI,CAAC,GAAG;IAAE,OAAO,EAAE,CAAC,CAAA;CAAE,CAAC"}

package/brand.js

@@ -21,4 +21,4 @@
  * SOFTWARE.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYnJhbmQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvYnJhbmQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOzs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW9CRyIsInNvdXJjZXNDb250ZW50IjpbIi8qXG4gKiBDb3B5cmlnaHQgKGMpIDIwMjEgRXJpayBGb3J0dW5lXG4gKlxuICogUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBvZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weVxuICogb2YgdGhpcyBzb2Z0d2FyZSBhbmQgYXNzb2NpYXRlZCBkb2N1bWVudGF0aW9uIGZpbGVzICh0aGUgXCJTb2Z0d2FyZVwiKSwgdG8gZGVhbFxuICogaW4gdGhlIFNvZnR3YXJlIHdpdGhvdXQgcmVzdHJpY3Rpb24sIGluY2x1ZGluZyB3aXRob3V0IGxpbWl0YXRpb24gdGhlIHJpZ2h0c1xuICogdG8gdXNlLCBjb3B5LCBtb2RpZnksIG1lcmdlLCBwdWJsaXNoLCBkaXN0cmlidXRlLCBzdWJsaWNlbnNlLCBhbmQvb3Igc2VsbFxuICogY29waWVzIG9mIHRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25zIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzXG4gKiBmdXJuaXNoZWQgdG8gZG8gc28sIHN1YmplY3QgdG8gdGhlIGZvbGxvd2luZyBjb25kaXRpb25zOlxuICpcbiAqIFRoZSBhYm92ZSBjb3B5cmlnaHQgbm90aWNlIGFuZCB0aGlzIHBlcm1pc3Npb24gbm90aWNlIHNoYWxsIGJlIGluY2x1ZGVkIGluIGFsbFxuICogY29waWVzIG9yIHN1YnN0YW50aWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS5cbiAqXG4gKiBUSEUgU09GVFdBUkUgSVMgUFJPVklERUQgXCJBUyBJU1wiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBLSU5ELCBFWFBSRVNTIE9SXG4gKiBJTVBMSUVELCBJTkNMVURJTkcgQlVUIE5PVCBMSU1JVEVEIFRPIFRIRSBXQVJSQU5USUVTIE9GIE1FUkNIQU5UQUJJTElUWSxcbiAqIEZJVE5FU1MgRk9SIEEgUEFSVElDVUxBUiBQVVJQT1NFIEFORCBOT05JTkZSSU5HRU1FTlQuIElOIE5PIEVWRU5UIFNIQUxMIFRIRVxuICogQVVUSE9SUyBPUiBDT1BZUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdFUyBPUiBPVEhFUlxuICogTElBQklMSVRZLCBXSEVUSEVSIElOIEFOIEFDVElPTiBPRiBDT05UUkFDVCwgVE9SVCBPUiBPVEhFUldJU0UsIEFSSVNJTkcgRlJPTSxcbiAqIE9VVCBPRiBPUiBJTiBDT05ORUNUSU9OIFdJVEggVEhFIFNPRlRXQVJFIE9SIFRIRSBVU0UgT1IgT1RIRVIgREVBTElOR1MgSU4gVEhFXG4gKiBTT0ZUV0FSRS5cbiAqL1xuXG4vKipcbiAqIEhlbHBlciB0eXBlIHRvIGJyYW5kIGEgc2ltcGxlIHR5cGUgdG8gcHJldmVudCBpbmFwcHJvcHJpYXRlIHVzZVxuICovXG4vLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25hbWluZy1jb252ZW50aW9uXG5leHBvcnQgdHlwZSBCcmFuZDxULCBCPiA9IFQgJiB7IF9fYnJhbmQ6IEIgfTtcbiJdfQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYnJhbmQuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvYnJhbmQudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IjtBQUFBOzs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQW9CRyIsInNvdXJjZXNDb250ZW50IjpbIi8qXG4gKiBDb3B5cmlnaHQgKGMpIDIwMjEgRXJpayBGb3J0dW5lXG4gKlxuICogUGVybWlzc2lvbiBpcyBoZXJlYnkgZ3JhbnRlZCwgZnJlZSBvZiBjaGFyZ2UsIHRvIGFueSBwZXJzb24gb2J0YWluaW5nIGEgY29weVxuICogb2YgdGhpcyBzb2Z0d2FyZSBhbmQgYXNzb2NpYXRlZCBkb2N1bWVudGF0aW9uIGZpbGVzICh0aGUgXCJTb2Z0d2FyZVwiKSwgdG8gZGVhbFxuICogaW4gdGhlIFNvZnR3YXJlIHdpdGhvdXQgcmVzdHJpY3Rpb24sIGluY2x1ZGluZyB3aXRob3V0IGxpbWl0YXRpb24gdGhlIHJpZ2h0c1xuICogdG8gdXNlLCBjb3B5LCBtb2RpZnksIG1lcmdlLCBwdWJsaXNoLCBkaXN0cmlidXRlLCBzdWJsaWNlbnNlLCBhbmQvb3Igc2VsbFxuICogY29waWVzIG9mIHRoZSBTb2Z0d2FyZSwgYW5kIHRvIHBlcm1pdCBwZXJzb25zIHRvIHdob20gdGhlIFNvZnR3YXJlIGlzXG4gKiBmdXJuaXNoZWQgdG8gZG8gc28sIHN1YmplY3QgdG8gdGhlIGZvbGxvd2luZyBjb25kaXRpb25zOlxuICpcbiAqIFRoZSBhYm92ZSBjb3B5cmlnaHQgbm90aWNlIGFuZCB0aGlzIHBlcm1pc3Npb24gbm90aWNlIHNoYWxsIGJlIGluY2x1ZGVkIGluIGFsbFxuICogY29waWVzIG9yIHN1YnN0YW50aWFsIHBvcnRpb25zIG9mIHRoZSBTb2Z0d2FyZS5cbiAqXG4gKiBUSEUgU09GVFdBUkUgSVMgUFJPVklERUQgXCJBUyBJU1wiLCBXSVRIT1VUIFdBUlJBTlRZIE9GIEFOWSBLSU5ELCBFWFBSRVNTIE9SXG4gKiBJTVBMSUVELCBJTkNMVURJTkcgQlVUIE5PVCBMSU1JVEVEIFRPIFRIRSBXQVJSQU5USUVTIE9GIE1FUkNIQU5UQUJJTElUWSxcbiAqIEZJVE5FU1MgRk9SIEEgUEFSVElDVUxBUiBQVVJQT1NFIEFORCBOT05JTkZSSU5HRU1FTlQuIElOIE5PIEVWRU5UIFNIQUxMIFRIRVxuICogQVVUSE9SUyBPUiBDT1BZUklHSFQgSE9MREVSUyBCRSBMSUFCTEUgRk9SIEFOWSBDTEFJTSwgREFNQUdFUyBPUiBPVEhFUlxuICogTElBQklMSVRZLCBXSEVUSEVSIElOIEFOIEFDVElPTiBPRiBDT05UUkFDVCwgVE9SVCBPUiBPVEhFUldJU0UsIEFSSVNJTkcgRlJPTSxcbiAqIE9VVCBPRiBPUiBJTiBDT05ORUNUSU9OIFdJVEggVEhFIFNPRlRXQVJFIE9SIFRIRSBVU0UgT1IgT1RIRVIgREVBTElOR1MgSU4gVEhFXG4gKiBTT0ZUV0FSRS5cbiAqL1xuXG4vKipcbiAqIEhlbHBlciB0eXBlIHRvIGJyYW5kIGEgc2ltcGxlIHR5cGUgdG8gcHJldmVudCBpbmFwcHJvcHJpYXRlIHVzZVxuICogQHB1YmxpY1xuICovXG4vLyBlc2xpbnQtZGlzYWJsZS1uZXh0LWxpbmUgQHR5cGVzY3JpcHQtZXNsaW50L25hbWluZy1jb252ZW50aW9uXG5leHBvcnQgdHlwZSBCcmFuZDxULCBCPiA9IFQgJiB7IF9fYnJhbmQ6IEIgfTtcbiJdfQ==

package/converter.d.ts

@@ -3,156 +3,268 @@ import { Brand } from './brand';
 declare type OnError = 'failOnError' | 'ignoreErrors';
 /**
  * Converter traits.
+ * @public
  */
 export interface ConverterTraits {
     readonly isOptional: boolean;
     readonly brand?: string;
 }
+/**
+ * Options for {@link Converter.withConstraint}.
+ * @public
+ */
+export interface ConstraintOptions {
+    /**
+     * Optional description for error messages when constraint
+     * function returns false.
+     */
+    readonly description: string;
+}
+/**
+ * Generic converter to convert unknown to a templated type `<T>`, using
+ * intrinsic rules or as modified by an optional conversion context
+ * of optional templated type `<TC>` (default `undefined`).
+ * @public
+ */
 export interface Converter<T, TC = undefined> extends ConverterTraits {
     /**
-     * Indicates whether this element is explicitly optional
+     * Indicates whether this element is explicitly optional.
      */
     readonly isOptional: boolean;
     /**
-     * Returns the brand for a branded type
+     * Returns the brand for a branded type.
      */
     readonly brand?: string;
     /**
-    * Converts from unknown to <T>
-    * @param from The unknown to be converted
-    * @param context An optional context applied to the conversion
-    * @returns An @see Result with a value or an error message
+    * Converts from `unknown` to `<T>`.
+    * @param from - The `unknown` to be converted
+    * @param context - An optional conversion context of type `<TC>` to be used in
+    * the conversion.
+    * @returns A {@link Result} with a {@link Success} and a value on success or an
+    * {@link Failure} with a a message on failure.
     */
     convert(from: unknown, context?: TC): Result<T>;
     /**
-     * Converts from unknown to <T> or undefined, as appropriate.
-     * If 'onError' is 'failOnError', the converter succeeds for
-     * 'undefined' or any convertible value, but reports an error
-     * if it encounters a value that cannot be converted.  If 'onError'
-     * is 'ignoreErrors' (default) then values that cannot be converted
-     * result in a successful return of 'undefined'.
-     * @param from The unknown to be converted
-     * @param context Optional context for use by the converter
-     * @param onError Specifies handling of values that cannot be converted, default 'ignoreErrors'
+     * Converts from `unknown` to `<T>` or `undefined`, as appropriate.
+     *
+     * @remarks
+     * If `onError` is `failOnError`, the converter succeeds for
+     * `undefined` or any convertible value, but reports an error
+     * if it encounters a value that cannot be converted.
+     *
+     * If `onError` is `ignoreErrors` (default) then values that
+     * cannot be converted result in a successful return of `undefined`.
+     * @param from - The `unknown` to be converted
+     * @param context - An optional conversion context of type `<TC>` to be used in
+     * the conversion.
+     * @param onError - Specifies handling of values that cannot be converted (default `ignoreErrors`).
+     * @returns A {@link Result} with a {@link Success} and a value on success or an
+     * {@link Failure} with a a message on failure.
      */
     convertOptional(from: unknown, context?: TC, onError?: OnError): Result<T | undefined>;
     /**
-     * Creates a converter for an optional value. If 'onError'
-     * is 'failOnError', the converter accepts 'undefined' or a
-     * convertible value, but reports an error if it encounters
-     * a value that cannot be converted.  If 'onError' is 'ignoreErrors'
-     * (default) then values that cannot be converted result in a
-     * successful return of 'undefined'.
+     * Creates a {@link Converter} for an optional value.
+     *
+     * @remarks
+     * If `onError` is `failOnError`, the resulting converter will accept `undefined`
+     * or a convertible value, but report an error if it encounters a value that cannot be
+     * converted.
      *
-     * @param onError Specifies handling of values that cannot be converted, default 'ignoreErrors'
+     * If `onError` is `ignoreErrors` (default) then values that cannot be converted will
+     * result in a successful return of `undefined`.
+     *
+     * @param onError - Specifies handling of values that cannot be converted (default `ignoreErrors`).
+     * @returns A new {@link Converter} returning `<T|undefined>`.
      * */
     optional(onError?: OnError): Converter<T | undefined, TC>;
     /**
-     * Applies a (possibly) mapping conversion to the converted value.
-     * @param mapper A function which maps from the converted type to some other type.
+     * Creates a {@link Converter} which applies a (possibly) mapping conversion to
+     * the converted value of this {@link Converter}.
+     * @param mapper - A function which maps from the the result type `<T>` of this
+     * converter to a new result type `<T2>`.
+     * @returns A new {@link Converter} returning `<T2>`.
      */
     map<T2>(mapper: (from: T) => Result<T2>): Converter<T2, TC>;
     /**
-     * Applies an additional converter to the converted value.
-     * @param mapConverter The converter to be applied to the converted value
+     * Creates a {@link Converter} which applies an additional supplied
+     * converter to the result of this converter.
+     *
+     * @param mapConverter - The {@link Converter} to be applied to the
+     * converted result from this {@link Converter}.
+     * @returns A new {@link Converter} returning `<T2>`.
      */
     mapConvert<T2>(mapConverter: Converter<T2>): Converter<T2, TC>;
     /**
-     * Creates a converter with an optional constraint.  If the base converter
-     * succeeds, calls a supplied constraint evaluation function with the
-     * value and fails the conversion if the function returns either false
-     * or Failure<T>.
+     * Creates a {@link Converter} which maps the individual items of a collection
+     * resulting from this {@link Converter} using the supplied map fuction.
      *
-     * @param constraint Constraint evaluation function
+     * @remarks
+     * Fails if `from` is not an array.
+     *
+     * @param mapper - The map function to be applied to each element of the
+     * result of this {@link Converter}.
+     * @returns A new {@link Converter} returning `<TI[]>`.
      */
-    withConstraint(constraint: (val: T) => boolean | Result<T>): Converter<T, TC>;
+    mapItems<TI>(mapper: (from: unknown) => Result<TI>): Converter<TI[], TC>;
     /**
-     * Adds a brand to the type to prevent mismatched usage of simple types
+     * Creates a {@link Converter} which maps the individual items of a collection
+     * resulting from this {@link Converter} using the supplied {@link Converter}.
+     *
+     * @remarks
+     * Fails if `from` is not an array.
+     *
+     * @param mapConverter - The {@link Converter} to be applied to each element of the
+     * result of this {@link Converter}.
+     * @returns A new {@link Converter} returning `<TI[]>`.
+     */
+    mapConvertItems<TI>(mapConverter: Converter<TI, unknown>): Converter<TI[], TC>;
+    /**
+     * Creates a {@link Converter} which applies a supplied type guard to the conversion
+     * result.
+     * @param guard - The type guard function to apply.
+     * @param message - Optional message to be reported if the type guard fails.
+     * @returns A new {@link Converter} returning `<TI>`.
+     */
+    withTypeGuard<TI>(guard: (from: unknown) => from is TI, message?: string): Converter<TI, TC>;
+    /**
+     * Creates a {@link Converter} which applies a supplied type guard to each member of
+     * the conversion result from this converter.
+     *
+     * @remarks
+     * Fails if the conversion result is not an array or if any member fails the
+     * type guard.
+     * @param guard - The type guard function to apply to each element.
+     * @param message - Optional message to be reported if the type guard fails.
+     * @returns A new {@link Converter} returning `<TI>`.
+     */
+    withItemTypeGuard<TI>(guard: (from: unknown) => from is TI, message?: string): Converter<TI[], TC>;
+    /**
+     * Creates a {@link Converter} which applies an optional constraint to the result
+     * of this conversion.  If this {@link Converter} (the base converter) succeeds, the new
+     * converter calls a supplied constraint evaluation function with the conversion, which
+     * fails the entire conversion if the constraint function returns either `false` or
+     * {@link Failure | Failure<T>}.
+     *
+     * @param constraint - Constraint evaluation function.
+     * @param options - {@link ConstraintOptions | Options} for constraint evaluation.
+     * @returns A new {@link Converter} returning `<T>`.
+     */
+    withConstraint(constraint: (val: T) => boolean | Result<T>, options?: ConstraintOptions): Converter<T, TC>;
+    /**
+     * returns a converter which adds a brand to the type to prevent mismatched usage
+     * of simple types.
+     * @param brand - The brand to be applied to the result value.
+     * @returns A {@link Converter} returning `Brand<T, B>`.
      */
     withBrand<B extends string>(brand: B): Converter<Brand<T, B>, TC>;
 }
+/**
+ * internal
+ */
 declare type InnerInferredType<TCONV> = TCONV extends Converter<infer TTO> ? (TTO extends Array<infer TTOELEM> ? InnerInferredType<TTOELEM>[] : TTO) : (TCONV extends Array<infer TELEM> ? InnerInferredType<TELEM>[] : TCONV);
 /**
  * Infers the type that will be returned by an intstantiated converter.  Works
  * for complex as well as simple types.
- * @example Infer<typeof Converters.mapOf(Converters.stringArray)> is Map<string, string[]>
+ * @example `Infer<typeof Converters.mapOf(Converters.stringArray)>` is `Map<string, string[]>`
+ * @beta
  */
 export declare type Infer<TCONV> = TCONV extends Converter<infer TTO> ? InnerInferredType<TTO> : never;
 /**
  * Deprecated name for Infer<T> retained for compatibility
  * @deprecated use @see Infer instead
+ * @internal
  */
 export declare type ConvertedToType<TCONV> = Infer<TCONV>;
 /**
- * Simple templated converter wrapper to simplify typed conversion from unknown.
+ * Base templated wrapper to simplify creation of new {@link Converter}s.
+ * @public
  */
 export declare class BaseConverter<T, TC = undefined> implements Converter<T, TC> {
+    /**
+     * @internal
+     */
     protected readonly _defaultContext?: TC;
+    /**
+     * @internal
+     */
     protected _isOptional: boolean;
+    /**
+     * @internal
+     */
     protected _brand?: string;
     private readonly _converter;
+    /**
+     * Constructs a new {@link Converter} which uses the supplied function to perform the conversion.
+     * @param converter - The conversion function to be applied.
+     * @param defaultContext - Optional conversion context to be used by default.
+     * @param traits - Optional {@link ConverterTraits | traits} to be assigned to the resulting
+     * converter.
+     */
     constructor(converter: (from: unknown, self: Converter<T, TC>, context?: TC) => Result<T>, defaultContext?: TC, traits?: ConverterTraits);
     /**
-     * Converts from unknown to <T>
-     * @param from The unknown to be converted
-     * @returns An @see Result with a value or an error message
+     * {@inheritdoc Converter.isOptional}
+     */
+    get isOptional(): boolean;
+    /**
+     * {@inheritdoc Converter.brand}
+     */
+    get brand(): string | undefined;
+    /**
+     * {@inheritdoc Converter.convert}
      */
     convert(from: unknown, context?: TC): Result<T>;
     /**
-     * Converts from unknown to <T> or undefined, as appropriate.
-     * If 'onError' is 'failOnError', the converter succeeds for
-     * 'undefined' or any convertible value, but reports an error
-     * if it encounters a value that cannot be converted.  If 'onError'
-     * is 'ignoreErrors' (default) then values that cannot be converted
-     * result in a successful return of 'undefined'.
-     * @param from The unknown to be converted
-     * @param onError Specifies handling of values that cannot be converted, default 'ignoreErrors'
+     * {@inheritdoc Converter.convertOptional}
      */
     convertOptional(from: unknown, context?: TC, onError?: OnError): Result<T | undefined>;
     /**
-     * Creates a converter for an optional value. If 'onError'
-     * is 'failOnError', the converter accepts 'undefined' or a
-     * convertible value, but reports an error if it encounters
-     * a value that cannot be converted.  If 'onError' is 'ignoreErrors'
-     * then values that cannot be converted result in a
-     * successful return of 'undefined'.
-     *
-     * @param onError Specifies handling of values that cannot be converted, default 'ignoreErrors'
-     * */
+     * {@inheritdoc Converter.optional}
+     */
     optional(onError?: OnError): Converter<T | undefined, TC>;
     /**
-     * Reports whether this value is explicitly optional
+     * {@inheritdoc Converter.map}
      */
-    get isOptional(): boolean;
+    map<T2>(mapper: (from: T) => Result<T2>): Converter<T2, TC>;
     /**
-     * Reports the brand of a branded type.
+     * {@inheritdoc Converter.mapConvert}
      */
-    get brand(): string | undefined;
+    mapConvert<T2>(mapConverter: Converter<T2>): Converter<T2, TC>;
     /**
-     * Applies a (possibly) mapping conversion to the converted value.
-     * @param mapper A function which maps from the converted type to some other type.
+     * {@inheritdoc Converter.mapItems}
      */
-    map<T2>(mapper: (from: T) => Result<T2>): Converter<T2, TC>;
+    mapItems<TI>(mapper: (from: unknown) => Result<TI>): Converter<TI[], TC>;
     /**
-     * Applies an additional converter to the converted value.
-     * @param mapConverter The converter to be applied to the converted value
+     * {@inheritdoc Converter.mapConvertItems}
      */
-    mapConvert<T2>(mapConverter: Converter<T2>): Converter<T2, TC>;
+    mapConvertItems<TI>(mapConverter: Converter<TI, unknown>): Converter<TI[], TC>;
     /**
-     * Creates a converter with an optional constraint.  If the base converter
-     * succeeds, calls a supplied constraint evaluation function with the
-     * value and fails the conversion if the function returns either false
-     * or Failure<T>.
-     *
-     * @param constraint Constraint evaluation function
+     * {@inheritdoc Converter.withTypeGuard}
+     */
+    withTypeGuard<TI>(guard: (from: unknown) => from is TI, message?: string): Converter<TI, TC>;
+    /**
+     * {@inheritdoc Converter.withItemTypeGuard}
      */
-    withConstraint(constraint: (val: T) => boolean | Result<T>): Converter<T, TC>;
+    withItemTypeGuard<TI>(guard: (from: unknown) => from is TI, message?: string): Converter<TI[], TC>;
     /**
-     * Adds a brand to the type to prevent mismatched usage of simple types
+     * {@inheritdoc Converter.withConstraint}
+     */
+    withConstraint(constraint: (val: T) => boolean | Result<T>, options?: ConstraintOptions): Converter<T, TC>;
+    /**
+     * {@inheritdoc Converter.withBrand}
      */
     withBrand<B extends string>(brand: B): Converter<Brand<T, B>, TC>;
+    /**
+     * @internal
+     */
     protected _context(supplied?: TC): TC | undefined;
+    /**
+     * @internal
+     */
     protected _traits(traits?: Partial<ConverterTraits>): ConverterTraits;
+    /**
+     * @internal
+     */
     protected _with(traits: Partial<ConverterTraits>): this;
 }
 export {};
+//# sourceMappingURL=converter.d.ts.map

package/converter.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"converter.d.ts","sourceRoot":"","sources":["../src/converter.ts"],"names":[],"mappings":"AAqBA,OAAO,EAAE,MAAM,EAA6B,MAAM,UAAU,CAAC;AAC7D,OAAO,EAAE,KAAK,EAAE,MAAM,SAAS,CAAC;AAEhC,aAAK,OAAO,GAAG,aAAa,GAAG,cAAc,CAAC;AAE9C;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC5B,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAC7B,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB;IAC9B;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;CAChC;AAED;;;;;GAKG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC,EAAE,EAAE,GAAC,SAAS,CAAE,SAAQ,eAAe;IAC/D;;OAEG;IACF,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC;IAExB;;;;;;;MAOE;IACH,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC,CAAC;IAEhD;;;;;;;;;;;;;;;;OAgBG;IACH,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC,GAAC,SAAS,CAAC,CAAC;IAErF;;;;;;;;;;;;;SAaK;IACL,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC,CAAC,GAAC,SAAS,EAAE,EAAE,CAAC,CAAC;IAExD;;;;;;OAMG;IACH,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAE5D;;;;;;;OAOG;IACH,UAAU,CAAC,EAAE,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAE/D;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAEzE;;;;;;;;;;OAUG;IACF,eAAe,CAAC,EAAE,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAE/E;;;;;;OAMG;IACJ,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC;IAE5F;;;;;;;;;;OAUG;IACF,iBAAiB,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC;IAErG;;;;;;;;;;OAUG;IACH,cAAc,CACV,UAAU,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,GAAC,MAAM,CAAC,CAAC,CAAC,EACzC,OAAO,CAAC,EAAE,iBAAiB,GAC5B,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;IAEpB;;;;;OAKG;IACH,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC;CACrE;AAED;;GAEG;AACH,aAAK,iBAAiB,CAAC,KAAK,IACxB,KAAK,SAAS,SAAS,CAAC,MAAM,GAAG,CAAC,GAC5B,CAAC,GAAG,SAAS,KAAK,CAAC,MAAM,OAAO,CAAC,GAAG,iBAAiB,CAAC,OAAO,CAAC,EAAE,GAAG,GAAG,CAAC,GACvE,CAAC,KAAK,SAAS,KAAK,CAAC,MAAM,KAAK,CAAC,GAAG,iBAAiB,CAAC,KAAK,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC;AAElF;;;;;GAKG;AACH,oBAAY,KAAK,CAAC,KAAK,IAAI,KAAK,SAAS,SAAS,CAAC,MAAM,GAAG,CAAC,GAAG,iBAAiB,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;AAE/F;;;;GAIG;AACH,oBAAY,eAAe,CAAC,KAAK,IAAI,KAAK,CAAC,KAAK,CAAC,CAAC;AAElD;;;GAGG;AACH,qBAAa,aAAa,CAAC,CAAC,EAAE,EAAE,GAAC,SAAS,CAAE,YAAW,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IACnE;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,eAAe,CAAC,EAAE,EAAE,CAAC;IACxC;;OAEG;IACH,SAAS,CAAC,WAAW,UAAS;IAC9B;;OAEG;IACH,SAAS,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAE1B,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAqE;IAEhG;;;;;;OAMG;gBAEC,SAAS,EAAE,CAAC,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,OAAO,CAAC,EAAE,EAAE,KAAK,MAAM,CAAC,CAAC,CAAC,EAC7E,cAAc,CAAC,EAAE,EAAE,EACnB,MAAM,CAAC,EAAE,eAAe;IAQ5B;;OAEG;IACH,IAAW,UAAU,IAAI,OAAO,CAE/B;IAED;;OAEG;IACH,IAAW,KAAK,IAAI,MAAM,GAAC,SAAS,CAEnC;IAED;;OAEG;IACI,OAAO,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,GAAG,MAAM,CAAC,CAAC,CAAC;IAItD;;OAEG;IACI,eAAe,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,CAAC,EAAE,EAAE,EAAE,OAAO,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC,CAAC,GAAC,SAAS,CAAC;IAS3F;;OAEG;IACI,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC,CAAC,GAAC,SAAS,EAAE,EAAE,CAAC;IAO9D;;OAEG;IACI,GAAG,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,KAAK,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC;IAUlE;;OAEG;IACI,UAAU,CAAC,EAAE,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC;IAWrE;;OAEG;IACI,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,MAAM,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAW/E;;OAEG;IACI,eAAe,CAAC,EAAE,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,EAAE,OAAO,CAAC,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAWrF;;OAEG;IACI,aAAa,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,CAAC;IASnG;;OAEG;IACI,iBAAiB,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,IAAI,EAAE,OAAO,KAAK,IAAI,IAAI,EAAE,EAAE,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC;IAczG;;OAEG;IACI,cAAc,CACjB,UAAU,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,OAAO,GAAC,MAAM,CAAC,CAAC,CAAC,EACzC,OAAO,CAAC,EAAE,iBAAiB,GAC5B,SAAS,CAAC,CAAC,EAAE,EAAE,CAAC;IAkBnB;;OAEG;IACI,SAAS,CAAC,CAAC,SAAS,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC;IAYxE;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,EAAE,GAAC,SAAS;IAI/C;;OAEG;IACH,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,eAAe;IAQrE;;OAEG;IACH,SAAS,CAAC,KAAK,CAAC,MAAM,EAAE,OAAO,CAAC,eAAe,CAAC,GAAG,IAAI;CAK1D"}