@clipboard-health/util-ts 2.1.3 → 2.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@clipboard-health/util-ts",
-  "version": "2.1.3",
+  "version": "2.2.1",
   "main": "./src/index.js",
   "publishConfig": {
     "access": "restricted"

package/src/index.d.ts

@@ -3,12 +3,14 @@ export * from "./lib/cbh-error";
 export * from "./lib/cbh-response";
 export * from "./lib/defined-utils";
 export * from "./lib/delay";
+export * from "./lib/either";
 export * from "./lib/force-cast";
 export * from "./lib/head";
 export * from "./lib/identity";
 export * from "./lib/is-string";
 export * from "./lib/non-empty-array";
 export * from "./lib/null-to-undefined";
+export * from "./lib/option";
 export * from "./lib/stringify";
 export * from "./lib/to-error";
 //# sourceMappingURL=index.d.ts.map

package/src/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/util-ts/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../packages/util-ts/src/index.ts"],"names":[],"mappings":"AAAA,cAAc,kBAAkB,CAAC;AACjC,cAAc,iBAAiB,CAAC;AAChC,cAAc,oBAAoB,CAAC;AACnC,cAAc,qBAAqB,CAAC;AACpC,cAAc,aAAa,CAAC;AAC5B,cAAc,cAAc,CAAC;AAC7B,cAAc,kBAAkB,CAAC;AACjC,cAAc,YAAY,CAAC;AAC3B,cAAc,gBAAgB,CAAC;AAC/B,cAAc,iBAAiB,CAAC;AAChC,cAAc,uBAAuB,CAAC;AACtC,cAAc,yBAAyB,CAAC;AACxC,cAAc,cAAc,CAAC;AAC7B,cAAc,iBAAiB,CAAC;AAChC,cAAc,gBAAgB,CAAC"}

package/src/index.js

@@ -6,12 +6,14 @@ tslib_1.__exportStar(require("./lib/cbh-error"), exports);
 tslib_1.__exportStar(require("./lib/cbh-response"), exports);
 tslib_1.__exportStar(require("./lib/defined-utils"), exports);
 tslib_1.__exportStar(require("./lib/delay"), exports);
+tslib_1.__exportStar(require("./lib/either"), exports);
 tslib_1.__exportStar(require("./lib/force-cast"), exports);
 tslib_1.__exportStar(require("./lib/head"), exports);
 tslib_1.__exportStar(require("./lib/identity"), exports);
 tslib_1.__exportStar(require("./lib/is-string"), exports);
 tslib_1.__exportStar(require("./lib/non-empty-array"), exports);
 tslib_1.__exportStar(require("./lib/null-to-undefined"), exports);
+tslib_1.__exportStar(require("./lib/option"), exports);
 tslib_1.__exportStar(require("./lib/stringify"), exports);
 tslib_1.__exportStar(require("./lib/to-error"), exports);
 //# sourceMappingURL=index.js.map

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/util-ts/src/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,0DAAgC;AAChC,6DAAmC;AACnC,8DAAoC;AACpC,sDAA4B;AAC5B,2DAAiC;AACjC,qDAA2B;AAC3B,yDAA+B;AAC/B,0DAAgC;AAChC,gEAAsC;AACtC,kEAAwC;AACxC,0DAAgC;AAChC,yDAA+B"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../packages/util-ts/src/index.ts"],"names":[],"mappings":";;;AAAA,2DAAiC;AACjC,0DAAgC;AAChC,6DAAmC;AACnC,8DAAoC;AACpC,sDAA4B;AAC5B,uDAA6B;AAC7B,2DAAiC;AACjC,qDAA2B;AAC3B,yDAA+B;AAC/B,0DAAgC;AAChC,gEAAsC;AACtC,kEAAwC;AACxC,uDAA6B;AAC7B,0DAAgC;AAChC,yDAA+B"}

package/src/lib/either.d.ts

@@ -0,0 +1,32 @@
+export interface Left<E> {
+    isRight: false;
+    left: E;
+}
+export interface Right<A> {
+    isRight: true;
+    right: A;
+}
+/**
+ * A value of either type `Left<E>` or type `Right<A>`; a disjoint union.
+ *
+ * A common use case is as an alternative to {@link Option} where `Left<E>` contains useful
+ * information. Convention dictates that `Left<E>` is used for failure and `Right<A>` for success.
+ */
+export type Either<E, A> = Left<E> | Right<A>;
+/**
+ * Constructs an `Either` holding a `Left<E>` value, usually representing a failure.
+ */
+export declare function left<E, A = never>(left: E): Either<E, A>;
+/**
+ * Constructs an `Either` holding a `Right<A>` value, usually representing a success.
+ */
+export declare function right<A, E = never>(right: A): Either<E, A>;
+/**
+ * Returns `true` if the either is `Left<E>`, `false` otherwise.
+ */
+export declare function isLeft<E, A>(either: Either<E, A>): either is Left<E>;
+/**
+ * Returns `true` if the either is `Right<A>`, `false` otherwise.
+ */
+export declare function isRight<E, A>(either: Either<E, A>): either is Right<A>;
+//# sourceMappingURL=either.d.ts.map

package/src/lib/either.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"either.d.ts","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/either.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,IAAI,CAAC,CAAC;IACrB,OAAO,EAAE,KAAK,CAAC;IACf,IAAI,EAAE,CAAC,CAAC;CACT;AAED,MAAM,WAAW,KAAK,CAAC,CAAC;IACtB,OAAO,EAAE,IAAI,CAAC;IACd,KAAK,EAAE,CAAC,CAAC;CACV;AAED;;;;;GAKG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,EAAE,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC;AAE9C;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,IAAI,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAExD;AAED;;GAEG;AACH,wBAAgB,KAAK,CAAC,CAAC,EAAE,CAAC,GAAG,KAAK,EAAE,KAAK,EAAE,CAAC,GAAG,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,CAE1D;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,CAEpE;AAED;;GAEG;AACH,wBAAgB,OAAO,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,MAAM,IAAI,KAAK,CAAC,CAAC,CAAC,CAEtE"}

package/src/lib/either.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.left = left;
+exports.right = right;
+exports.isLeft = isLeft;
+exports.isRight = isRight;
+/**
+ * Constructs an `Either` holding a `Left<E>` value, usually representing a failure.
+ */
+function left(left) {
+    return { isRight: false, left };
+}
+/**
+ * Constructs an `Either` holding a `Right<A>` value, usually representing a success.
+ */
+function right(right) {
+    return { isRight: true, right };
+}
+/**
+ * Returns `true` if the either is `Left<E>`, `false` otherwise.
+ */
+function isLeft(either) {
+    return !either.isRight;
+}
+/**
+ * Returns `true` if the either is `Right<A>`, `false` otherwise.
+ */
+function isRight(either) {
+    return either.isRight;
+}
+//# sourceMappingURL=either.js.map

package/src/lib/either.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"either.js","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/either.ts"],"names":[],"mappings":";;AAqBA,oBAEC;AAKD,sBAEC;AAKD,wBAEC;AAKD,0BAEC;AA1BD;;GAEG;AACH,SAAgB,IAAI,CAAe,IAAO;IACxC,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,SAAgB,KAAK,CAAe,KAAQ;IAC1C,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AAClC,CAAC;AAED;;GAEG;AACH,SAAgB,MAAM,CAAO,MAAoB;IAC/C,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC;AACzB,CAAC;AAED;;GAEG;AACH,SAAgB,OAAO,CAAO,MAAoB;IAChD,OAAO,MAAM,CAAC,OAAO,CAAC;AACxB,CAAC"}

package/src/lib/option.d.ts

@@ -0,0 +1,28 @@
+export interface None {
+    isSome: false;
+}
+export interface Some<A> {
+    isSome: true;
+    value: A;
+}
+/**
+ * An optional value. If the value exists, it's of type `Some<A>`, otherwise it's of type `None`.
+ */
+export type Option<A> = None | Some<A>;
+/**
+ * Constructs an `Option` of `None`, representing a missing value.
+ */
+export declare const none: None;
+/**
+ * Constructs an `Option` holding a `Some<A>`, representing an optional value that exists.
+ */
+export declare function some<A>(value: A): Some<A>;
+/**
+ * Returns `true` if the option is `None`, `false` otherwise.
+ */
+export declare function isNone<A>(option: Option<A>): option is None;
+/**
+ * Returns `true` if the option is `Some<A>`, `false` otherwise.
+ */
+export declare function isSome<A>(option: Option<A>): option is Some<A>;
+//# sourceMappingURL=option.d.ts.map

package/src/lib/option.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"option.d.ts","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/option.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,IAAI;IACnB,MAAM,EAAE,KAAK,CAAC;CACf;AAED,MAAM,WAAW,IAAI,CAAC,CAAC;IACrB,MAAM,EAAE,IAAI,CAAC;IACb,KAAK,EAAE,CAAC,CAAC;CACV;AAED;;GAEG;AACH,MAAM,MAAM,MAAM,CAAC,CAAC,IAAI,IAAI,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;AAEvC;;GAEG;AACH,eAAO,MAAM,IAAI,EAAE,IAAwB,CAAC;AAE5C;;GAEG;AACH,wBAAgB,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC,CAEzC;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,IAAI,CAE3D;AAED;;GAEG;AACH,wBAAgB,MAAM,CAAC,CAAC,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,IAAI,IAAI,CAAC,CAAC,CAAC,CAE9D"}

package/src/lib/option.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.none = void 0;
+exports.some = some;
+exports.isNone = isNone;
+exports.isSome = isSome;
+/**
+ * Constructs an `Option` of `None`, representing a missing value.
+ */
+exports.none = { isSome: false };
+/**
+ * Constructs an `Option` holding a `Some<A>`, representing an optional value that exists.
+ */
+function some(value) {
+    return { isSome: true, value };
+}
+/**
+ * Returns `true` if the option is `None`, `false` otherwise.
+ */
+function isNone(option) {
+    return !option.isSome;
+}
+/**
+ * Returns `true` if the option is `Some<A>`, `false` otherwise.
+ */
+function isSome(option) {
+    return option.isSome;
+}
+//# sourceMappingURL=option.js.map

package/src/lib/option.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"option.js","sourceRoot":"","sources":["../../../../../packages/util-ts/src/lib/option.ts"],"names":[],"mappings":";;;AAsBA,oBAEC;AAKD,wBAEC;AAKD,wBAEC;AAxBD;;GAEG;AACU,QAAA,IAAI,GAAS,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AAE5C;;GAEG;AACH,SAAgB,IAAI,CAAI,KAAQ;IAC9B,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AACjC,CAAC;AAED;;GAEG;AACH,SAAgB,MAAM,CAAI,MAAiB;IACzC,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC;AACxB,CAAC;AAED;;GAEG;AACH,SAAgB,MAAM,CAAI,MAAiB;IACzC,OAAO,MAAM,CAAC,MAAM,CAAC;AACvB,CAAC"}