@praha/byethrow 0.3.0 → 0.4.0

package/dist/cjs/exports.cjs

@@ -27,6 +27,9 @@ var __webpack_modules__ = {
     "./functions/is-failure": function(module) {
         module.exports = require("./functions/is-failure.cjs");
     },
+    "./functions/is-result": function(module) {
+        module.exports = require("./functions/is-result.cjs");
+    },
     "./functions/is-success": function(module) {
         module.exports = require("./functions/is-success.cjs");
     },
@@ -161,58 +164,64 @@ var __webpack_exports__ = {};
         return _functions_is_failure__WEBPACK_IMPORTED_MODULE_9__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_is_success__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__("./functions/is-success");
+    var _functions_is_result__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__("./functions/is-result");
+    var __WEBPACK_REEXPORT_OBJECT__ = {};
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_is_result__WEBPACK_IMPORTED_MODULE_10__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_is_result__WEBPACK_IMPORTED_MODULE_10__[key];
+    }).bind(0, __WEBPACK_IMPORT_KEY__);
+    __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
+    var _functions_is_success__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__("./functions/is-success");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_is_success__WEBPACK_IMPORTED_MODULE_10__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_is_success__WEBPACK_IMPORTED_MODULE_10__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_is_success__WEBPACK_IMPORTED_MODULE_11__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_is_success__WEBPACK_IMPORTED_MODULE_11__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_map__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__("./functions/map");
+    var _functions_map__WEBPACK_IMPORTED_MODULE_12__ = __webpack_require__("./functions/map");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_map__WEBPACK_IMPORTED_MODULE_11__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_map__WEBPACK_IMPORTED_MODULE_11__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_map__WEBPACK_IMPORTED_MODULE_12__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_map__WEBPACK_IMPORTED_MODULE_12__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_map_error__WEBPACK_IMPORTED_MODULE_12__ = __webpack_require__("./functions/map-error");
+    var _functions_map_error__WEBPACK_IMPORTED_MODULE_13__ = __webpack_require__("./functions/map-error");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_map_error__WEBPACK_IMPORTED_MODULE_12__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_map_error__WEBPACK_IMPORTED_MODULE_12__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_map_error__WEBPACK_IMPORTED_MODULE_13__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_map_error__WEBPACK_IMPORTED_MODULE_13__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_or_else__WEBPACK_IMPORTED_MODULE_13__ = __webpack_require__("./functions/or-else");
+    var _functions_or_else__WEBPACK_IMPORTED_MODULE_14__ = __webpack_require__("./functions/or-else");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_or_else__WEBPACK_IMPORTED_MODULE_13__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_or_else__WEBPACK_IMPORTED_MODULE_13__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_or_else__WEBPACK_IMPORTED_MODULE_14__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_or_else__WEBPACK_IMPORTED_MODULE_14__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_pipe__WEBPACK_IMPORTED_MODULE_14__ = __webpack_require__("./functions/pipe");
+    var _functions_pipe__WEBPACK_IMPORTED_MODULE_15__ = __webpack_require__("./functions/pipe");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_pipe__WEBPACK_IMPORTED_MODULE_14__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_pipe__WEBPACK_IMPORTED_MODULE_14__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_pipe__WEBPACK_IMPORTED_MODULE_15__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_pipe__WEBPACK_IMPORTED_MODULE_15__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_succeed__WEBPACK_IMPORTED_MODULE_15__ = __webpack_require__("./functions/succeed");
+    var _functions_succeed__WEBPACK_IMPORTED_MODULE_16__ = __webpack_require__("./functions/succeed");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_succeed__WEBPACK_IMPORTED_MODULE_15__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_succeed__WEBPACK_IMPORTED_MODULE_15__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_succeed__WEBPACK_IMPORTED_MODULE_16__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_succeed__WEBPACK_IMPORTED_MODULE_16__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_try__WEBPACK_IMPORTED_MODULE_16__ = __webpack_require__("./functions/try");
+    var _functions_try__WEBPACK_IMPORTED_MODULE_17__ = __webpack_require__("./functions/try");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_try__WEBPACK_IMPORTED_MODULE_16__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_try__WEBPACK_IMPORTED_MODULE_16__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_try__WEBPACK_IMPORTED_MODULE_17__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_try__WEBPACK_IMPORTED_MODULE_17__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_unwrap__WEBPACK_IMPORTED_MODULE_17__ = __webpack_require__("./functions/unwrap");
+    var _functions_unwrap__WEBPACK_IMPORTED_MODULE_18__ = __webpack_require__("./functions/unwrap");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_unwrap__WEBPACK_IMPORTED_MODULE_17__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_unwrap__WEBPACK_IMPORTED_MODULE_17__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_unwrap__WEBPACK_IMPORTED_MODULE_18__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_unwrap__WEBPACK_IMPORTED_MODULE_18__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
-    var _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_18__ = __webpack_require__("./functions/unwrap-error");
+    var _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_19__ = __webpack_require__("./functions/unwrap-error");
     var __WEBPACK_REEXPORT_OBJECT__ = {};
-    for(var __WEBPACK_IMPORT_KEY__ in _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_18__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
-        return _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_18__[key];
+    for(var __WEBPACK_IMPORT_KEY__ in _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_19__)if ("default" !== __WEBPACK_IMPORT_KEY__) __WEBPACK_REEXPORT_OBJECT__[__WEBPACK_IMPORT_KEY__] = (function(key) {
+        return _functions_unwrap_error__WEBPACK_IMPORTED_MODULE_19__[key];
     }).bind(0, __WEBPACK_IMPORT_KEY__);
     __webpack_require__.d(__webpack_exports__, __WEBPACK_REEXPORT_OBJECT__);
 })();

package/dist/cjs/exports.d.ts

@@ -8,6 +8,7 @@ export * from './functions/fail';
 export * from './functions/inspect';
 export * from './functions/inspect-error';
 export * from './functions/is-failure';
+export * from './functions/is-result';
 export * from './functions/is-success';
 export * from './functions/map';
 export * from './functions/map-error';

package/dist/cjs/functions/is-result.cjs

@@ -0,0 +1,36 @@
+"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__, {
+    isResult: ()=>isResult
+});
+const isResult = (result)=>'object' == typeof result && null !== result && 'type' in result && ('Success' === result.type && 'value' in result || 'Failure' === result.type && 'error' in result);
+exports.isResult = __webpack_exports__.isResult;
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "isResult"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/cjs/functions/is-result.d.ts

@@ -0,0 +1,24 @@
+import type { Result } from '../result';
+/**
+ * Type guard to check if a value is a {@link Result}.
+ *
+ * @function
+ * @typeParam T - The type of the success value.
+ * @typeParam E - The type of the error value.
+ * @param result - The value to check.
+ * @returns `true` if the value is a {@link Result}, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * import { Result } from '@praha/byethrow';
+ *
+ * const value: unknown = { type: 'Success', value: 42 };
+ * if (Result.isResult(value)) {
+ *   // value is now typed as Result<unknown, unknown>
+ *   console.log(value.type); // 'Success' or 'Failure'
+ * }
+ * ```
+ *
+ * @category Type Guards
+ */
+export declare const isResult: <T, E>(result: unknown) => result is Result<T, E>;

package/dist/esm/exports.d.ts

@@ -8,6 +8,7 @@ export * from './functions/fail';
 export * from './functions/inspect';
 export * from './functions/inspect-error';
 export * from './functions/is-failure';
+export * from './functions/is-result';
 export * from './functions/is-success';
 export * from './functions/map';
 export * from './functions/map-error';

package/dist/esm/exports.js

@@ -8,6 +8,7 @@ export * from "./functions/fail.js";
 export * from "./functions/inspect.js";
 export * from "./functions/inspect-error.js";
 export * from "./functions/is-failure.js";
+export * from "./functions/is-result.js";
 export * from "./functions/is-success.js";
 export * from "./functions/map.js";
 export * from "./functions/map-error.js";

package/dist/esm/functions/is-result.d.ts

@@ -0,0 +1,24 @@
+import type { Result } from '../result';
+/**
+ * Type guard to check if a value is a {@link Result}.
+ *
+ * @function
+ * @typeParam T - The type of the success value.
+ * @typeParam E - The type of the error value.
+ * @param result - The value to check.
+ * @returns `true` if the value is a {@link Result}, otherwise `false`.
+ *
+ * @example
+ * ```ts
+ * import { Result } from '@praha/byethrow';
+ *
+ * const value: unknown = { type: 'Success', value: 42 };
+ * if (Result.isResult(value)) {
+ *   // value is now typed as Result<unknown, unknown>
+ *   console.log(value.type); // 'Success' or 'Failure'
+ * }
+ * ```
+ *
+ * @category Type Guards
+ */
+export declare const isResult: <T, E>(result: unknown) => result is Result<T, E>;

package/dist/esm/functions/is-result.js

@@ -0,0 +1,2 @@
+const isResult = (result)=>'object' == typeof result && null !== result && 'type' in result && ('Success' === result.type && 'value' in result || 'Failure' === result.type && 'error' in result);
+export { isResult };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@praha/byethrow",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "A lightweight, tree-shakable Result type package with a simple, consistent API designed",
   "keywords": [
     "javascript",
@@ -41,9 +41,9 @@
     "README.md"
   ],
   "devDependencies": {
-    "@rslib/core": "0.10.2",
-    "eslint": "9.29.0",
-    "typedoc": "0.28.5",
+    "@rslib/core": "0.10.4",
+    "eslint": "9.30.0",
+    "typedoc": "0.28.7",
     "typescript": "5.8.3",
     "vitest": "3.2.4"
   },