@praha/byethrow 0.1.0 → 0.2.0

package/dist/cjs/exports.cjs

@@ -30,6 +30,9 @@ var __webpack_modules__ = {
     "./functions/map": function(module) {
         module.exports = require("./functions/map.cjs");
     },
+    "./functions/or-else": function(module) {
+        module.exports = require("./functions/or-else.cjs");
+    },
     "./functions/pipe": function(module) {
         module.exports = require("./functions/pipe.cjs");
     },
@@ -158,34 +161,40 @@ var __webpack_exports__ = {};
         return _functions_map_error__WEBPACK_IMPORTED_MODULE_10__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_pipe__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__("./functions/pipe");
+    var _functions_or_else__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__("./functions/or-else");
+    var __WEBPACK_REEXPORT_OBJECT__ = {};
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_or_else__WEBPACK_IMPORTED_MODULE_11__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_or_else__WEBPACK_IMPORTED_MODULE_11__[key];
+    }).bind(0, __WEBPACK_IMPORT_KEY__);
+    __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
+    var _functions_pipe__WEBPACK_IMPORTED_MODULE_12__ = __webpack_require__("./functions/pipe");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_pipe__WEBPACK_IMPORTED_MODULE_11__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_pipe__WEBPACK_IMPORTED_MODULE_11__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_pipe__WEBPACK_IMPORTED_MODULE_12__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_pipe__WEBPACK_IMPORTED_MODULE_12__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_succeed__WEBPACK_IMPORTED_MODULE_12__ = __webpack_require__("./functions/succeed");
+    var _functions_succeed__WEBPACK_IMPORTED_MODULE_13__ = __webpack_require__("./functions/succeed");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_succeed__WEBPACK_IMPORTED_MODULE_12__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_succeed__WEBPACK_IMPORTED_MODULE_12__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_succeed__WEBPACK_IMPORTED_MODULE_13__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_succeed__WEBPACK_IMPORTED_MODULE_13__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_try__WEBPACK_IMPORTED_MODULE_13__ = __webpack_require__("./functions/try");
+    var _functions_try__WEBPACK_IMPORTED_MODULE_14__ = __webpack_require__("./functions/try");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_try__WEBPACK_IMPORTED_MODULE_13__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_try__WEBPACK_IMPORTED_MODULE_13__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_try__WEBPACK_IMPORTED_MODULE_14__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_try__WEBPACK_IMPORTED_MODULE_14__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_unwrap__WEBPACK_IMPORTED_MODULE_14__ = __webpack_require__("./functions/unwrap");
+    var _functions_unwrap__WEBPACK_IMPORTED_MODULE_15__ = __webpack_require__("./functions/unwrap");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_unwrap__WEBPACK_IMPORTED_MODULE_14__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_unwrap__WEBPACK_IMPORTED_MODULE_14__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_unwrap__WEBPACK_IMPORTED_MODULE_15__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_unwrap__WEBPACK_IMPORTED_MODULE_15__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_15__ = __webpack_require__("./functions/unwrap-error");
+    var _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_16__ = __webpack_require__("./functions/unwrap-error");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_15__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_15__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_16__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_16__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
 })();

package/dist/cjs/exports.d.ts

@@ -9,6 +9,7 @@ export * from './functions/is-failure';
 export * from './functions/is-success';
 export * from './functions/map';
 export * from './functions/map-error';
+export * from './functions/or-else';
 export * from './functions/pipe';
 export * from './functions/succeed';
 export * from './functions/try';

package/dist/cjs/functions/or-else.cjs

@@ -0,0 +1,44 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.d = (exports1, definition)=>{
+        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+            enumerable: true,
+            get: definition[key]
+        });
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    orElse: ()=>orElse
+});
+const external_is_success_cjs_namespaceObject = require("./is-success.cjs");
+const is_promise_cjs_namespaceObject = require("../internals/helpers/is-promise.cjs");
+const orElse = (fn)=>(result)=>{
+        const apply = (r)=>{
+            if ((0, external_is_success_cjs_namespaceObject.isSuccess)(r)) return r;
+            return fn(r.error);
+        };
+        return (0, is_promise_cjs_namespaceObject.isPromise)(result) ? result.then(apply) : apply(result);
+    };
+exports.orElse = __webpack_exports__.orElse;
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "orElse"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/cjs/functions/or-else.d.ts

@@ -0,0 +1,47 @@
+import type { InferFailure, InferSuccess, ResultFor, ResultMaybeAsync } from '../result';
+/**
+ * Chains the next computation using the error value of a {@link Result} or {@link ResultAsync}.
+ * If the original result is a {@link Success}, it is returned unchanged.
+ * Otherwise, the provided function is called, and its result is returned as-is.
+ *
+ * @function
+ * @typeParam R1 - The input {@link Result} or {@link ResultAsync}.
+ * @typeParam R2 - The result type returned by `fn`.
+ *
+ * @example Success Case
+ * ```ts
+ * import { Result } from '@praha/byethrow';
+ *
+ * const result = Result.pipe(
+ *   Result.succeed(42),
+ *   Result.orElse((error) => Result.succeed(0)),
+ * );
+ * // { type: 'Success', value: 42 }
+ * ```
+ *
+ * @example Failure Case (function returns a Success)
+ * ```ts
+ * const result = Result.pipe(
+ *   Result.fail('original error'),
+ *   Result.orElse((error) => Result.succeed('default value')),
+ * );
+ * // result: { type: 'Success', value: 'default value' }
+ * ```
+ *
+ * @example Failure Case (function returns a Failure)
+ * ```ts
+ * const result = Result.pipe(
+ *   Result.fail('original error'),
+ *   Result.orElse((error) => Result.fail('new error: ' + error)),
+ * );
+ * // result: { type: 'Failure', error: 'new error: original error' }
+ * ```
+ *
+ * @see {@link pipe} - It is recommended to use this function with the {@link pipe} function for better readability and composability.
+ *
+ * @category Combinators
+ */
+export declare const orElse: {
+    <R1 extends ResultMaybeAsync<any, any>, R2 extends ResultMaybeAsync<any, any>>(fn: (a: InferFailure<R1>) => R2): (result: R1) => ResultFor<R1 | R2, InferSuccess<R1> | InferSuccess<R2>, InferFailure<R2>>;
+    <F extends (a: any) => ResultMaybeAsync<any, any>>(fn: F): <R1 extends ResultMaybeAsync<any, Parameters<F>[0]>>(result: R1) => ResultFor<R1 | ReturnType<F>, InferSuccess<R1> | InferSuccess<F>, InferFailure<F>>;
+};

package/dist/esm/exports.d.ts

@@ -9,6 +9,7 @@ export * from './functions/is-failure';
 export * from './functions/is-success';
 export * from './functions/map';
 export * from './functions/map-error';
+export * from './functions/or-else';
 export * from './functions/pipe';
 export * from './functions/succeed';
 export * from './functions/try';

package/dist/esm/exports.js

@@ -9,6 +9,7 @@ export * from "./functions/is-failure.js";
 export * from "./functions/is-success.js";
 export * from "./functions/map.js";
 export * from "./functions/map-error.js";
+export * from "./functions/or-else.js";
 export * from "./functions/pipe.js";
 export * from "./functions/succeed.js";
 export * from "./functions/try.js";

package/dist/esm/functions/or-else.d.ts

@@ -0,0 +1,47 @@
+import type { InferFailure, InferSuccess, ResultFor, ResultMaybeAsync } from '../result';
+/**
+ * Chains the next computation using the error value of a {@link Result} or {@link ResultAsync}.
+ * If the original result is a {@link Success}, it is returned unchanged.
+ * Otherwise, the provided function is called, and its result is returned as-is.
+ *
+ * @function
+ * @typeParam R1 - The input {@link Result} or {@link ResultAsync}.
+ * @typeParam R2 - The result type returned by `fn`.
+ *
+ * @example Success Case
+ * ```ts
+ * import { Result } from '@praha/byethrow';
+ *
+ * const result = Result.pipe(
+ *   Result.succeed(42),
+ *   Result.orElse((error) => Result.succeed(0)),
+ * );
+ * // { type: 'Success', value: 42 }
+ * ```
+ *
+ * @example Failure Case (function returns a Success)
+ * ```ts
+ * const result = Result.pipe(
+ *   Result.fail('original error'),
+ *   Result.orElse((error) => Result.succeed('default value')),
+ * );
+ * // result: { type: 'Success', value: 'default value' }
+ * ```
+ *
+ * @example Failure Case (function returns a Failure)
+ * ```ts
+ * const result = Result.pipe(
+ *   Result.fail('original error'),
+ *   Result.orElse((error) => Result.fail('new error: ' + error)),
+ * );
+ * // result: { type: 'Failure', error: 'new error: original error' }
+ * ```
+ *
+ * @see {@link pipe} - It is recommended to use this function with the {@link pipe} function for better readability and composability.
+ *
+ * @category Combinators
+ */
+export declare const orElse: {
+    <R1 extends ResultMaybeAsync<any, any>, R2 extends ResultMaybeAsync<any, any>>(fn: (a: InferFailure<R1>) => R2): (result: R1) => ResultFor<R1 | R2, InferSuccess<R1> | InferSuccess<R2>, InferFailure<R2>>;
+    <F extends (a: any) => ResultMaybeAsync<any, any>>(fn: F): <R1 extends ResultMaybeAsync<any, Parameters<F>[0]>>(result: R1) => ResultFor<R1 | ReturnType<F>, InferSuccess<R1> | InferSuccess<F>, InferFailure<F>>;
+};

package/dist/esm/functions/or-else.js

@@ -0,0 +1,10 @@
+import { isSuccess } from "./is-success.js";
+import { isPromise } from "../internals/helpers/is-promise.js";
+const orElse = (fn)=>(result)=>{
+        const apply = (r)=>{
+            if (isSuccess(r)) return r;
+            return fn(r.error);
+        };
+        return isPromise(result) ? result.then(apply) : apply(result);
+    };
+export { orElse };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@praha/byethrow",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "A lightweight, tree-shakable Result type package with a simple, consistent API designed",
   "keywords": [
     "javascript",