@fgv/ts-utils 5.0.1 → 5.0.2-0

package/dist/packlets/conversion/converters.js

@@ -106,14 +106,7 @@ export const number = new BaseConverter((from) => {
     }
     return succeed(from);
 });
-/**
- * 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
- */
-export const boolean = new BaseConverter((from) => {
+const booleanConverter = new BaseConverter((from) => {
     if (typeof from === 'boolean') {
         return succeed(from);
     }
@@ -127,6 +120,14 @@ export const boolean = new BaseConverter((from) => {
     }
     return fail(`Not a boolean: ${JSON.stringify(from)}`);
 });
+/**
+ * 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
+ */
+export const boolean = booleanConverter;
 /**
  * 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`.
@@ -207,7 +208,7 @@ export const optionalNumber = number.optional();
  * with value `undefined`.
  * @public
  */
-export const optionalBoolean = boolean.optional();
+export const optionalBoolean = booleanConverter.optional();
 /**
  * A helper function to create a {@link Converter | Converter} for polymorphic values.
  * Returns a converter which invokes the wrapped converters in sequence, returning the

package/dist/ts-utils.d.ts

@@ -1060,7 +1060,7 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
            * failure details in addition to the error message.
            * @public
            */
-          export declare class DetailedFailure<T, TD> extends Failure<T> {
+          export declare class DetailedFailure<out T, out TD> extends Failure<T> {
               /**
                * @internal
                */
@@ -1154,7 +1154,7 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
            * details in addition to the error message.
            * @public
            */
-          export declare class DetailedSuccess<T, TD> extends Success<T> {
+          export declare class DetailedSuccess<out T, out TD> extends Success<T> {
               /**
                * @internal
                */
@@ -1323,7 +1323,7 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
            * Reports a failed {@link IResult | result} from some operation, with an error message.
            * @public
            */
-          export declare class Failure<T> implements IResult<T> {
+          export declare class Failure<out T> implements IResult<T> {
               /**
                * {@inheritdoc IResult.success}
                */
@@ -4161,7 +4161,7 @@ declare class Collectible<TKEY extends string = string, TINDEX extends number =
                               * corresponding value.
                               * @public
                               */
-                             export declare class Success<T> implements IResult<T> {
+                             export declare class Success<out T> implements IResult<T> {
                                  /**
                                   * {@inheritdoc IResult.success}
                                   */

package/lib/packlets/base/result.d.ts

@@ -298,7 +298,7 @@ export interface IResult<T> {
  * corresponding value.
  * @public
  */
-export declare class Success<T> implements IResult<T> {
+export declare class Success<out T> implements IResult<T> {
     /**
      * {@inheritdoc IResult.success}
      */
@@ -394,7 +394,7 @@ export declare class Success<T> implements IResult<T> {
  * Reports a failed {@link IResult | result} from some operation, with an error message.
  * @public
  */
-export declare class Failure<T> implements IResult<T> {
+export declare class Failure<out T> implements IResult<T> {
     /**
      * {@inheritdoc IResult.success}
      */
@@ -551,7 +551,7 @@ export type DetailedFailureContinuation<T, TD> = (message: string, detail?: TD)
  * details in addition to the error message.
  * @public
  */
-export declare class DetailedSuccess<T, TD> extends Success<T> {
+export declare class DetailedSuccess<out T, out TD> extends Success<T> {
     /**
      * @internal
      */
@@ -619,7 +619,7 @@ export declare class DetailedSuccess<T, TD> extends Success<T> {
  * failure details in addition to the error message.
  * @public
  */
-export declare class DetailedFailure<T, TD> extends Failure<T> {
+export declare class DetailedFailure<out T, out TD> extends Failure<T> {
     /**
      * @internal
      */

package/lib/packlets/conversion/converters.js

@@ -130,14 +130,7 @@ exports.number = new baseConverter_1.BaseConverter((from) => {
     }
     return (0, base_1.succeed)(from);
 });
-/**
- * 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 baseConverter_1.BaseConverter((from) => {
+const booleanConverter = new baseConverter_1.BaseConverter((from) => {
     if (typeof from === 'boolean') {
         return (0, base_1.succeed)(from);
     }
@@ -151,6 +144,14 @@ exports.boolean = new baseConverter_1.BaseConverter((from) => {
     }
     return (0, base_1.fail)(`Not a boolean: ${JSON.stringify(from)}`);
 });
+/**
+ * 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 = booleanConverter;
 /**
  * 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`.
@@ -231,7 +232,7 @@ exports.optionalNumber = exports.number.optional();
  * with value `undefined`.
  * @public
  */
-exports.optionalBoolean = exports.boolean.optional();
+exports.optionalBoolean = booleanConverter.optional();
 /**
  * A helper function to create a {@link Converter | Converter} for polymorphic values.
  * Returns a converter which invokes the wrapped converters in sequence, returning the

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fgv/ts-utils",
-  "version": "5.0.1",
+  "version": "5.0.2-0",
   "description": "Assorted Typescript Utilities",
   "main": "lib/index.js",
   "module": "dist/index.js",
@@ -55,6 +55,10 @@
     "eslint-plugin-tsdoc": "~0.4.0",
     "@fgv/heft-dual-rig": "0.1.0"
   },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ErikFortune/fgv.git"
+  },
   "scripts": {
     "build": "heft build --clean",
     "clean": "heft clean",