retuple 1.0.0-next.11 → 1.0.0-next.12

package/dist/index.cjs

@@ -12,7 +12,7 @@ var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (
 };
 var _ResultAsync_inner;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.RetupleArrayMethodUnavailableError = exports.RetupleInvalidResultError = exports.RetupleThrownValueError = exports.RetupleFlattenFailed = exports.RetupleExpectFailed = exports.RetupleUnwrapErrFailed = exports.RetupleUnwrapFailed = void 0;
+exports.RetupleArrayMethodUnavailableError = exports.RetupleInvalidUnionError = exports.RetupleInvalidResultError = exports.RetupleThrownValueError = exports.RetupleFlattenFailed = exports.RetupleExpectFailed = exports.RetupleUnwrapErrFailed = exports.RetupleUnwrapFailed = void 0;
 exports.Result = Result;
 exports.Ok = Ok;
 exports.Err = Err;
@@ -95,6 +95,22 @@ class RetupleInvalidResultError extends Error {
     }
 }
 exports.RetupleInvalidResultError = RetupleInvalidResultError;
+/**
+ * ## Retuple Invalid Union Error
+ *
+ * This error is thrown when attempting to construct a `Result` from a
+ * discriminated union, when the 'success' property is not boolean. In this
+ * case, it is impossible to determine whether the result should be `Ok` or
+ * `Err`.
+ */
+class RetupleInvalidUnionError extends Error {
+    constructor(value) {
+        super("Constructing a Result from discriminated union failed, the success " +
+            "property must be boolean");
+        this.value = value;
+    }
+}
+exports.RetupleInvalidUnionError = RetupleInvalidUnionError;
 /**
  * ## Retuple Array Method Unavailable Error
  *
@@ -128,6 +144,7 @@ Result.Err = Err;
 Result.$resolve = resolve;
 Result.$nonNullable = nonNullable;
 Result.$truthy = truthy;
+Result.$union = union;
 Result.$safe = safe;
 Result.$safeAsync = safeAsync;
 Result.$safePromise = safePromise;
@@ -161,6 +178,15 @@ function truthy(value, error = mapTrue) {
     }
     return Err(error());
 }
+function union(union) {
+    if (union.success === true) {
+        return Ok(union.data);
+    }
+    if (union.success === false) {
+        return Err(union.error);
+    }
+    throw new RetupleInvalidUnionError(union);
+}
 function safe(f, mapError = ensureError) {
     try {
         return Ok(f());

package/dist/index.d.cts

@@ -62,6 +62,18 @@ export declare class RetupleInvalidResultError extends Error {
     value: unknown[];
     constructor(value: unknown[]);
 }
+/**
+ * ## Retuple Invalid Union Error
+ *
+ * This error is thrown when attempting to construct a `Result` from a
+ * discriminated union, when the 'success' property is not boolean. In this
+ * case, it is impossible to determine whether the result should be `Ok` or
+ * `Err`.
+ */
+export declare class RetupleInvalidUnionError extends Error {
+    value: unknown;
+    constructor(value: unknown);
+}
 /**
  * ## Retuple Array Method Unavailable Error
  *
@@ -83,6 +95,7 @@ export declare namespace Result {
     var $resolve: typeof resolve;
     var $nonNullable: typeof nonNullable;
     var $truthy: typeof truthy;
+    var $union: typeof union;
     var $safe: typeof safe;
     var $safeAsync: typeof safeAsync;
     var $safePromise: typeof safePromise;
@@ -224,6 +237,7 @@ declare function nonNullable<const T, E>(value: T, error: () => E): Result<NonNu
  */
 declare function truthy<const T>(value: T): Result<Truthy<T>, true>;
 declare function truthy<const T, E>(value: T, error: () => E): Result<Truthy<T>, E>;
+declare function union<U extends ObjectUnionOk<any> | ObjectUnionErr<any>>(union: U): Result<U extends ObjectUnionOk<infer T> ? T : never, U extends ObjectUnionErr<infer E> ? E : never>;
 /**
  * Construct a {@link Result} from a synchronous function call. If the function
  * returns without throwing, the result is `Ok`.
@@ -939,6 +953,16 @@ type OkTuple<T> = [err: undefined, value: T];
 type ErrTuple<E> = [err: E, value: undefined];
 type ThisOk<T> = OkTuple<T> & Retuple<T, never>;
 type ThisErr<E> = ErrTuple<E> & Retuple<never, E>;
+type ObjectUnionOk<T> = {
+    success: true;
+    data: T;
+    error?: never | undefined;
+};
+type ObjectUnionErr<E> = {
+    success: false;
+    data?: never | undefined;
+    error: E;
+};
 type RetupleAwaitable<T, E> = Retuple<T, E> | PromiseLike<Retuple<T, E>>;
 interface Retuple<T, E> extends RetupleArray<T | E | undefined> {
     /**

package/dist/index.d.ts

@@ -62,6 +62,18 @@ export declare class RetupleInvalidResultError extends Error {
     value: unknown[];
     constructor(value: unknown[]);
 }
+/**
+ * ## Retuple Invalid Union Error
+ *
+ * This error is thrown when attempting to construct a `Result` from a
+ * discriminated union, when the 'success' property is not boolean. In this
+ * case, it is impossible to determine whether the result should be `Ok` or
+ * `Err`.
+ */
+export declare class RetupleInvalidUnionError extends Error {
+    value: unknown;
+    constructor(value: unknown);
+}
 /**
  * ## Retuple Array Method Unavailable Error
  *
@@ -83,6 +95,7 @@ export declare namespace Result {
     var $resolve: typeof resolve;
     var $nonNullable: typeof nonNullable;
     var $truthy: typeof truthy;
+    var $union: typeof union;
     var $safe: typeof safe;
     var $safeAsync: typeof safeAsync;
     var $safePromise: typeof safePromise;
@@ -224,6 +237,7 @@ declare function nonNullable<const T, E>(value: T, error: () => E): Result<NonNu
  */
 declare function truthy<const T>(value: T): Result<Truthy<T>, true>;
 declare function truthy<const T, E>(value: T, error: () => E): Result<Truthy<T>, E>;
+declare function union<U extends ObjectUnionOk<any> | ObjectUnionErr<any>>(union: U): Result<U extends ObjectUnionOk<infer T> ? T : never, U extends ObjectUnionErr<infer E> ? E : never>;
 /**
  * Construct a {@link Result} from a synchronous function call. If the function
  * returns without throwing, the result is `Ok`.
@@ -939,6 +953,16 @@ type OkTuple<T> = [err: undefined, value: T];
 type ErrTuple<E> = [err: E, value: undefined];
 type ThisOk<T> = OkTuple<T> & Retuple<T, never>;
 type ThisErr<E> = ErrTuple<E> & Retuple<never, E>;
+type ObjectUnionOk<T> = {
+    success: true;
+    data: T;
+    error?: never | undefined;
+};
+type ObjectUnionErr<E> = {
+    success: false;
+    data?: never | undefined;
+    error: E;
+};
 type RetupleAwaitable<T, E> = Retuple<T, E> | PromiseLike<Retuple<T, E>>;
 interface Retuple<T, E> extends RetupleArray<T | E | undefined> {
     /**

package/dist/index.js

@@ -83,6 +83,21 @@ export class RetupleInvalidResultError extends Error {
         this.value = value;
     }
 }
+/**
+ * ## Retuple Invalid Union Error
+ *
+ * This error is thrown when attempting to construct a `Result` from a
+ * discriminated union, when the 'success' property is not boolean. In this
+ * case, it is impossible to determine whether the result should be `Ok` or
+ * `Err`.
+ */
+export class RetupleInvalidUnionError extends Error {
+    constructor(value) {
+        super("Constructing a Result from discriminated union failed, the success " +
+            "property must be boolean");
+        this.value = value;
+    }
+}
 /**
  * ## Retuple Array Method Unavailable Error
  *
@@ -115,6 +130,7 @@ Result.Err = Err;
 Result.$resolve = resolve;
 Result.$nonNullable = nonNullable;
 Result.$truthy = truthy;
+Result.$union = union;
 Result.$safe = safe;
 Result.$safeAsync = safeAsync;
 Result.$safePromise = safePromise;
@@ -148,6 +164,15 @@ function truthy(value, error = mapTrue) {
     }
     return Err(error());
 }
+function union(union) {
+    if (union.success === true) {
+        return Ok(union.data);
+    }
+    if (union.success === false) {
+        return Err(union.error);
+    }
+    throw new RetupleInvalidUnionError(union);
+}
 function safe(f, mapError = ensureError) {
     try {
         return Ok(f());

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "retuple",
-  "version": "1.0.0-next.11",
+  "version": "1.0.0-next.12",
   "scripts": {
     "test": "vitest",
     "lint": "eslint . --ext .ts -c eslint.config.mjs --fix",