zresult 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,6 @@
+# 1.0.0 (2026-04-13)
+
+
+### Features
+
+* first working version ([fa0de11](https://github.com/nfroidure/zresult/commit/fa0de110c7281aa56b5388d0b1b6cbd883b36606))

package/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+Copyright © 2017 Nicolas Froidure
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

package/README.md

@@ -0,0 +1,218 @@
+[//]: # ( )
+[//]: # (This file is automatically generated by a `metapak`)
+[//]: # (module. Do not change it  except between the)
+[//]: # (`content:start/end` flags, your changes would)
+[//]: # (be overridden.)
+[//]: # ( )
+# zresult
+> It helps to know the error you'll get.
+
+[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nfroidure/zresult/blob/main/LICENSE)
+
+
+[//]: # (::contents:start)
+
+`zresult` is an ultra-lightweight TypeScript wrapper designed to transform error
+handling into a predictable, strictly typed, and elegant data flow. Inspired by
+the `Result` pattern from Rust and Go, it integrates natively with `yerror` to
+provide absolute **Type Safety** for your error codes.
+
+## Key Features
+
+- ✅ **No more noisy `try/catch`**: Handle errors as return values.
+- ✅ **Exhaustive Type Safety**: Your error codes and debug data are validated
+  via the [yerror](https://www.npmjs.com/package/yerror)'s `YErrorRegistry`
+  type.
+- ✅ **Explicit Flow**: Clear distinction between synchronous and asynchronous
+  operations.
+- ✅ **Selective Catching**: Capture only the errors you know how to handle, let
+  the others bubble up (e.g., unexpected bugs or `ReferenceError`).
+
+## Installation
+
+```bash
+npm install zresult yerror
+```
+
+## Quick Start
+
+### 1. Creating Success or Failure
+
+```ts
+import { ok, fail } from 'zresult';
+
+const success = ok(42);
+// returns { ok: true, value: 42 }
+
+const failure = fail('E_USER_NOT_FOUND', ['123']);
+// returns { ok: false, error: YError }
+```
+
+### 2. Executing a Function (Attempt)
+
+Use attempt for asynchronous functions and attemptSync for the synchronous
+world.
+
+```ts
+import { attempt, attemptSync } from 'zresult';
+
+// Asynchronous
+const result = await attempt(fetchUser, userId);
+
+if (!result.ok) {
+  console.error(result.error.code); // Strictly typed!
+  return;
+}
+console.log(result.value.name);
+
+// Synchronous
+const config = attemptSync(parseConfig, rawData);
+```
+
+### 3. Selective Capture (The "From" Pattern)
+
+Only handle expected errors and let unexpected bugs crash the process cleanly.
+
+```ts
+import { attemptFrom } from 'zresult';
+
+// We only capture 'E_NETWORK' errors
+const result = await attemptFrom(['E_NETWORK'], sendMessage, msg);
+
+if (!result.ok) {
+  // result.error is strictly typed as YError<'E_NETWORK'> here
+  return retry(msg);
+}
+```
+
+### 4. Stabilizing an existing Promise (Settle)
+
+Useful for transforming a Promise from a third-party library into a Result.
+
+```ts
+import { settle } from 'zresult';
+
+const result = await settle(externalApi.call());
+```
+
+### Integration with YError
+
+`zresult` shines when used with a declared `YErrorRegistry`. TypeScript will
+prevent you from using non-existent error codes or invalid debug arguments.
+
+```ts
+declare module 'yerror' {
+  interface YErrorRegistry {
+    E_ACCESS_DENIED: [userId: string];
+  }
+}
+
+// TypeScript validates both 'E_ACCESS_DENIED' and the debug array contents
+return fail('E_ACCESS_DENIED', ['user_123']);
+```
+
+[//]: # (::contents:end)
+
+# API
+## Functions
+
+<dl>
+<dt><a href="#ok">ok()</a></dt>
+<dd><p>Create a successful result</p>
+</dd>
+<dt><a href="#fail">fail()</a></dt>
+<dd><p>Create a failure result using a YError code and debug values</p>
+</dd>
+<dt><a href="#failWith">failWith()</a></dt>
+<dd><p>Wrap an existing error into a failure result</p>
+</dd>
+<dt><a href="#settle">settle()</a></dt>
+<dd><p>Transform a Promise into a Result catching any error</p>
+</dd>
+<dt><a href="#settleFrom">settleFrom()</a></dt>
+<dd><p>Transform a Promise into a Result catching only known
+errors and letting unknown pass through</p>
+</dd>
+<dt><a href="#attempt">attempt()</a></dt>
+<dd><p>Runs an asynchronous function and provides a Result catching
+any error</p>
+</dd>
+<dt><a href="#attemptFrom">attemptFrom()</a></dt>
+<dd><p>Runs an asynchronous function and provides a Result catching
+only known errors and letting unknown pass through</p>
+</dd>
+<dt><a href="#attemptSync">attemptSync()</a></dt>
+<dd><p>Runs a synchronous function and provides a Result catching
+ any error</p>
+</dd>
+<dt><a href="#attemptSyncFrom">attemptSyncFrom()</a></dt>
+<dd><p>Runs a synchronous function and provides a Result catching
+ only known errors and letting unknown pass through</p>
+</dd>
+</dl>
+
+<a name="ok"></a>
+
+## ok()
+Create a successful result
+
+**Kind**: global function  
+<a name="fail"></a>
+
+## fail()
+Create a failure result using a YError code and debug values
+
+**Kind**: global function  
+<a name="failWith"></a>
+
+## failWith()
+Wrap an existing error into a failure result
+
+**Kind**: global function  
+<a name="settle"></a>
+
+## settle()
+Transform a Promise into a Result catching any error
+
+**Kind**: global function  
+<a name="settleFrom"></a>
+
+## settleFrom()
+Transform a Promise into a Result catching only known
+errors and letting unknown pass through
+
+**Kind**: global function  
+<a name="attempt"></a>
+
+## attempt()
+Runs an asynchronous function and provides a Result catching
+any error
+
+**Kind**: global function  
+<a name="attemptFrom"></a>
+
+## attemptFrom()
+Runs an asynchronous function and provides a Result catching
+only known errors and letting unknown pass through
+
+**Kind**: global function  
+<a name="attemptSync"></a>
+
+## attemptSync()
+Runs a synchronous function and provides a Result catching
+ any error
+
+**Kind**: global function  
+<a name="attemptSyncFrom"></a>
+
+## attemptSyncFrom()
+Runs a synchronous function and provides a Result catching
+ only known errors and letting unknown pass through
+
+**Kind**: global function  
+
+# Authors
+- [Nicolas Froidure](http://insertafter.com/en/index.html)
+
+# License
+[MIT](https://github.com/nfroidure/zresult/blob/main/LICENSE)

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+import { type YErrorDebug, type YErrorRegistry, YError } from 'yerror';
+/** A type to encapsulate a result that can either be
+ * failure or a success  */
+export type Result<T, E extends Error | YError> = {
+    readonly ok: true;
+    readonly value: T;
+} | {
+    readonly ok: false;
+    readonly error: E;
+};
+/** Create a successful result */
+export declare function ok<T>(value: T): Result<T, never>;
+/** Create a failure result using a YError code and debug values */
+export declare function fail<C extends keyof YErrorRegistry>(code: C, debug: YErrorDebug<C>, error?: Error): Result<never, YError<C>>;
+/** Wrap an existing error into a failure result */
+export declare function failWith<E extends Error | YError>(error: E): Result<never, E extends YError<infer C> ? YError<C> : YError<'E_UNEXPECTED'>>;
+/** Transform a Promise into a Result catching any error */
+export declare function settle<T>(promise: Promise<T>): Promise<Result<T, YError>>;
+/** Transform a Promise into a Result catching only known
+ * errors and letting unknown pass through */
+export declare function settleFrom<C extends keyof YErrorRegistry, T>(codes: C[], promise: Promise<T>): Promise<Result<T, YError<C>>>;
+/** Runs an asynchronous function and provides a Result catching
+ * any error */
+export declare function attempt<T, A extends any[]>(fn: (...args: A) => Promise<T>, ...args: A): Promise<Result<T, YError>>;
+/** Runs an asynchronous function and provides a Result catching
+ * only known errors and letting unknown pass through */
+export declare function attemptFrom<C extends keyof YErrorRegistry, T, A extends any[]>(codes: C[], fn: (...args: A) => Promise<T>, ...args: A): Promise<Result<T, YError<C>>>;
+/** Runs a synchronous function and provides a Result catching
+ *  any error */
+export declare function attemptSync<T, A extends any[]>(fn: (...args: A) => T, ...args: A): Result<T, YError>;
+/** Runs a synchronous function and provides a Result catching
+ *  only known errors and letting unknown pass through */
+export declare function attemptSyncFrom<C extends keyof YErrorRegistry, T, A extends any[]>(codes: C[], fn: (...args: A) => T, ...args: A): Result<T, YError<C>>;

package/dist/index.js

@@ -0,0 +1,101 @@
+import { looksLikeAYError, YError, hasYErrorCode, } from 'yerror';
+/** Create a successful result */
+export function ok(value) {
+    return {
+        ok: true,
+        value,
+    };
+}
+/** Create a failure result using a YError code and debug values */
+export function fail(code, debug, error) {
+    return {
+        ok: false,
+        error: new YError(code, debug, { cause: error }),
+    };
+}
+/** Wrap an existing error into a failure result */
+export function failWith(error) {
+    return {
+        ok: false,
+        error: (looksLikeAYError(error)
+            ? error
+            : new YError('E_UNEXPECTED', [], { cause: error })),
+    };
+}
+/** Transform a Promise into a Result catching any error */
+export async function settle(promise) {
+    try {
+        const value = await promise;
+        return ok(value);
+    }
+    catch (err) {
+        return failWith(YError.cast(err));
+    }
+}
+/** Transform a Promise into a Result catching only known
+ * errors and letting unknown pass through */
+export async function settleFrom(codes, promise) {
+    try {
+        const value = await promise;
+        return ok(value);
+    }
+    catch (err) {
+        for (const code of codes) {
+            if (hasYErrorCode(err, code)) {
+                return failWith(err);
+            }
+        }
+        throw err;
+    }
+}
+/** Runs an asynchronous function and provides a Result catching
+ * any error */
+export async function attempt(fn, ...args) {
+    try {
+        return ok(await fn(...args));
+    }
+    catch (err) {
+        return failWith(YError.cast(err));
+    }
+}
+/** Runs an asynchronous function and provides a Result catching
+ * only known errors and letting unknown pass through */
+export async function attemptFrom(codes, fn, ...args) {
+    try {
+        return ok(await fn(...args));
+    }
+    catch (err) {
+        for (const code of codes) {
+            if (hasYErrorCode(err, code)) {
+                return failWith(err);
+            }
+        }
+        throw err;
+    }
+}
+/** Runs a synchronous function and provides a Result catching
+ *  any error */
+export function attemptSync(fn, ...args) {
+    try {
+        return ok(fn(...args));
+    }
+    catch (err) {
+        return failWith(YError.cast(err));
+    }
+}
+/** Runs a synchronous function and provides a Result catching
+ *  only known errors and letting unknown pass through */
+export function attemptSyncFrom(codes, fn, ...args) {
+    try {
+        return ok(fn(...args));
+    }
+    catch (err) {
+        for (const code of codes) {
+            if (hasYErrorCode(err, code)) {
+                return failWith(err);
+            }
+        }
+        throw err;
+    }
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,gBAAgB,EAChB,MAAM,EACN,aAAa,GACd,MAAM,QAAQ,CAAC;AAQhB,iCAAiC;AACjC,MAAM,UAAU,EAAE,CAAI,KAAQ;IAC5B,OAAO;QACL,EAAE,EAAE,IAAI;QACR,KAAK;KACN,CAAC;AACJ,CAAC;AAED,mEAAmE;AACnE,MAAM,UAAU,IAAI,CAClB,IAAO,EACP,KAAqB,EACrB,KAAa;IAEb,OAAO;QACL,EAAE,EAAE,KAAK;QACT,KAAK,EAAE,IAAI,MAAM,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;KACjD,CAAC;AACJ,CAAC;AAED,mDAAmD;AACnD,MAAM,UAAU,QAAQ,CACtB,KAAQ;IAKR,OAAO;QACL,EAAE,EAAE,KAAK;QACT,KAAK,EAAE,CAAC,gBAAgB,CAAC,KAAK,CAAC;YAC7B,CAAC,CAAC,KAAK;YACP,CAAC,CAAC,IAAI,MAAM,CAAC,cAAc,EAAE,EAAE,EAAE,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC,CAI1B;KAC3B,CAAC;AACJ,CAAC;AAED,2DAA2D;AAC3D,MAAM,CAAC,KAAK,UAAU,MAAM,CAC1B,OAAmB;IAEnB,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC;QAE5B,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAY,CAAC,CAAC,CAAC;IAC7C,CAAC;AACH,CAAC;AAED;6CAC6C;AAC7C,MAAM,CAAC,KAAK,UAAU,UAAU,CAC9B,KAAU,EACV,OAAmB;IAEnB,IAAI,CAAC;QACH,MAAM,KAAK,GAAG,MAAM,OAAO,CAAC;QAE5B,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC;IACnB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC7B,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;QACD,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC;AAED;eACe;AACf,MAAM,CAAC,KAAK,UAAU,OAAO,CAI3B,EAA8B,EAAE,GAAG,IAAO;IAC1C,IAAI,CAAC;QACH,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAC/B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAY,CAAC,CAAC,CAAC;IAC7C,CAAC;AACH,CAAC;AAED;wDACwD;AACxD,MAAM,CAAC,KAAK,UAAU,WAAW,CAM/B,KAAU,EACV,EAA8B,EAC9B,GAAG,IAAO;IAEV,IAAI,CAAC;QACH,OAAO,EAAE,CAAC,MAAM,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IAC/B,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC7B,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;QACD,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC;AAED;gBACgB;AAChB,MAAM,UAAU,WAAW,CAIzB,EAAqB,EAAE,GAAG,IAAO;IACjC,IAAI,CAAC;QACH,OAAO,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,OAAO,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,GAAY,CAAC,CAAC,CAAC;IAC7C,CAAC;AACH,CAAC;AAED;yDACyD;AACzD,MAAM,UAAU,eAAe,CAK7B,KAAU,EAAE,EAAqB,EAAE,GAAG,IAAO;IAC7C,IAAI,CAAC;QACH,OAAO,EAAE,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,CAAC,CAAC;IACzB,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACb,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,IAAI,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,CAAC;gBAC7B,OAAO,QAAQ,CAAC,GAAG,CAAC,CAAC;YACvB,CAAC;QACH,CAAC;QACD,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC"}

package/dist/index.test.d.ts

@@ -0,0 +1,9 @@
+declare module 'yerror' {
+    interface YErrorRegistry {
+        E_ERROR: `arg${number}`[];
+        E_ERROR_1: [string, string];
+        E_ERROR_2: [`arg2.1`, `arg2.2`];
+        E_ERROR_3: [`arg3.1`, `arg3.2`];
+    }
+}
+export {};

package/dist/index.test.js

@@ -0,0 +1,271 @@
+import { describe, test, expect } from '@jest/globals';
+import { ok, fail, failWith, settle, settleFrom, attempt, attemptFrom, attemptSync, attemptSyncFrom, } from './index.js';
+import { YError } from 'yerror';
+describe('zeerror', () => {
+    describe('ok()', () => {
+        test('should produce a result with a value', () => {
+            const result = ok({ my: 'result' });
+            if (result.ok) {
+                const value = result.value.my;
+                expect(value).toEqual('result');
+                // @ts-expect-error : expect error if type is casted
+                expect(result.value.not).toBeUndefined();
+            }
+            else {
+                // @ts-expect-error : expect error since no value
+                expect(result.value).toBeUndefined();
+            }
+        });
+    });
+    describe('fail()', () => {
+        test('should produce a result with an error', () => {
+            const error = new Error('E_AOUCH');
+            const result = fail('E_ERROR_2', ['arg2.1', 'arg2.2'], error);
+            if (result.ok) {
+                // @ts-expect-error : expect error since no error
+                expect(result.error).toBeUndefined();
+            }
+            else {
+                // @ts-expect-error : expect error since nothing at this index
+                expect(result.error.debug[2]).toBeUndefined();
+                expect(result.error.debug).toEqual([`arg2.1`, `arg2.2`]);
+                expect(result.error.cause).toEqual(error);
+            }
+        });
+    });
+    describe('failWith()', () => {
+        test('should produce a result with an error', () => {
+            const error = new Error('E_AOUCH');
+            const result = failWith(error);
+            if (result.ok) {
+                // @ts-expect-error : expect error since no error
+                expect(result.error).toBeUndefined();
+            }
+            else {
+                expect(result.error.code).toEqual('E_UNEXPECTED');
+                expect(result.error.cause).toEqual(error);
+            }
+        });
+        test('should produce a result with a yerror', () => {
+            const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+            const result = failWith(error);
+            if (result.ok) {
+                // @ts-expect-error : expect error since no error
+                expect(result.error).toBeUndefined();
+            }
+            else {
+                expect(result.error.debug[1]).toEqual('arg2.2');
+                // @ts-expect-error : expect error since nothing at this index
+                expect(result.error.debug[2]).toBeUndefined();
+                expect(result.error).toEqual(error);
+            }
+        });
+        test('should handle non-error throws', () => {
+            const result = failWith('Something went wrong');
+            expect(result.ok).toBe(false);
+            if (!result.ok) {
+                expect(result.error.code).toEqual('E_UNEXPECTED');
+            }
+        });
+    });
+    describe('settle()', () => {
+        test('should produce a result with a promise of a value', async () => {
+            const resultPromise = settle(Promise.resolve({ my: 'result' }));
+            const result = await resultPromise;
+            if (result.ok) {
+                const value = result.value.my;
+                expect(value).toEqual('result');
+                // @ts-expect-error : expect error if type is casted
+                expect(result.value.not).toBeUndefined();
+            }
+            else {
+                // @ts-expect-error : expect error since no value
+                expect(result.value).toBeUndefined();
+            }
+        });
+        test('should produce a result with a promise of an error', async () => {
+            const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+            const resultPromise = settle(Promise.reject(error));
+            const result = await resultPromise;
+            if (result.ok) {
+                // @ts-expect-error : expect error since no error
+                expect(result.error).toBeUndefined();
+            }
+            else {
+                expect(result.error.debug[1]).toEqual('arg2.2');
+                expect(result.error.debug[2]).toBeUndefined();
+                expect(result.error).toEqual(error);
+            }
+        });
+    });
+    describe('settleFrom()', () => {
+        test('should produce a result with a promise of a value', async () => {
+            const resultPromise = settleFrom(['E_ERROR'], Promise.resolve({ my: 'result' }));
+            const result = await resultPromise;
+            if (result.ok) {
+                const value = result.value.my;
+                expect(value).toEqual('result');
+                // @ts-expect-error : expect error if type is casted
+                expect(result.value.not).toBeUndefined();
+            }
+            else {
+                // @ts-expect-error : expect error since no value
+                expect(result.value).toBeUndefined();
+            }
+        });
+        test('should produce a result with a promise of an error', async () => {
+            const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+            const resultPromise = settleFrom(['E_ERROR_2'], Promise.reject(error));
+            const result = await resultPromise;
+            if (result.ok) {
+                // @ts-expect-error : expect error since no error
+                expect(result.error).toBeUndefined();
+            }
+            else {
+                expect(result.error.debug[1]).toEqual('arg2.2');
+                // @ts-expect-error : expect error since nothing at this index
+                expect(result.error.debug[2]).toBeUndefined();
+                expect(result.error).toEqual(error);
+            }
+        });
+        test('should let unknown errors pass through', async () => {
+            const unknownError = new YError('E_ERROR_3', ['arg3.1', 'arg3.2']);
+            await expect(settleFrom(['E_ERROR_2'], Promise.reject(unknownError))).rejects.toThrow(unknownError);
+        });
+    });
+    describe('attempt()', () => {
+        test('should produce a result with a promise of a value', async () => {
+            const resultPromise = attempt(async (test) => ({ my: test }), 'result');
+            const result = await resultPromise;
+            if (result.ok) {
+                const value = result.value.my;
+                expect(value).toEqual('result');
+                // @ts-expect-error : expect error if type is casted
+                expect(result.value.not).toBeUndefined();
+            }
+            else {
+                // @ts-expect-error : expect error since no value
+                expect(result.value).toBeUndefined();
+            }
+        });
+        test('should produce a result with a promise of an error', async () => {
+            const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+            const resultPromise = attempt(() => Promise.reject(error));
+            const result = await resultPromise;
+            if (result.ok) {
+                // @ts-expect-error : expect error since no error
+                expect(result.error).toBeUndefined();
+            }
+            else {
+                expect(result.error.debug[1]).toEqual('arg2.2');
+                expect(result.error.debug[2]).toBeUndefined();
+                expect(result.error).toEqual(error);
+            }
+        });
+        test('should catch synchronous throws', async () => {
+            const error = new Error('Sync crash');
+            const result = await attempt(async () => {
+                throw error;
+            });
+            if (!result.ok) {
+                expect(result.error.cause).toEqual(error);
+            }
+            else {
+                throw new YError('E_UNEXPECTED_SUCCESS');
+            }
+        });
+    });
+    describe('attemptFrom()', () => {
+        test('should produce a result with a promise of a value', async () => {
+            const resultPromise = attemptFrom(['E_ERROR'], async (test) => ({ my: test }), 'result');
+            const result = await resultPromise;
+            if (result.ok) {
+                const value = result.value.my;
+                expect(value).toEqual('result');
+                // @ts-expect-error : expect error if type is casted
+                expect(result.value.not).toBeUndefined();
+            }
+            else {
+                // @ts-expect-error : expect error since no value
+                expect(result.value).toBeUndefined();
+            }
+        });
+        test('should produce a result with a promise of an error', async () => {
+            const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+            const resultPromise = attemptFrom(['E_ERROR_2'], () => Promise.reject(error));
+            const result = await resultPromise;
+            if (result.ok) {
+                // @ts-expect-error : expect error since no error
+                expect(result.error).toBeUndefined();
+            }
+            else {
+                expect(result.error.debug[1]).toEqual('arg2.2');
+                // @ts-expect-error : expect error since nothing at this index
+                expect(result.error.debug[2]).toBeUndefined();
+                expect(result.error).toEqual(error);
+            }
+        });
+    });
+    describe('attemptSync()', () => {
+        test('should produce a result with a value', () => {
+            const result = attemptSync((test) => ({ my: test }), 'result');
+            if (result.ok) {
+                const value = result.value.my;
+                expect(value).toEqual('result');
+                // @ts-expect-error : expect error if type is casted
+                expect(result.value.not).toBeUndefined();
+            }
+            else {
+                // @ts-expect-error : expect error since no value
+                expect(result.value).toBeUndefined();
+            }
+        });
+        test('should produce a result with an error', async () => {
+            const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+            const result = attemptSync(() => {
+                throw error;
+            });
+            if (result.ok) {
+                // @ts-expect-error : expect error since no error
+                expect(result.error).toBeUndefined();
+            }
+            else {
+                expect(result.error.debug[1]).toEqual('arg2.2');
+                expect(result.error.debug[2]).toBeUndefined();
+                expect(result.error).toEqual(error);
+            }
+        });
+    });
+    describe('attemptSyncFrom()', () => {
+        test('should produce a result with a value', () => {
+            const result = attemptSyncFrom(['E_ERROR'], (test) => ({ my: test }), 'result');
+            if (result.ok) {
+                const value = result.value.my;
+                expect(value).toEqual('result');
+                // @ts-expect-error : expect error if type is casted
+                expect(result.value.not).toBeUndefined();
+            }
+            else {
+                // @ts-expect-error : expect error since no value
+                expect(result.value).toBeUndefined();
+            }
+        });
+        test('should produce a result with an error', () => {
+            const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+            const result = attemptSyncFrom(['E_ERROR_2'], () => {
+                throw error;
+            });
+            if (result.ok) {
+                // @ts-expect-error : expect error since no error
+                expect(result.error).toBeUndefined();
+            }
+            else {
+                expect(result.error.debug[1]).toEqual('arg2.2');
+                // @ts-expect-error : expect error since nothing at this index
+                expect(result.error.debug[2]).toBeUndefined();
+                expect(result.error).toEqual(error);
+            }
+        });
+    });
+});
+//# sourceMappingURL=index.test.js.map

package/dist/index.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.test.js","sourceRoot":"","sources":["../src/index.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvD,OAAO,EACL,EAAE,EACF,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,UAAU,EACV,OAAO,EACP,WAAW,EACX,WAAW,EACX,eAAe,GAChB,MAAM,YAAY,CAAC;AACpB,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAC;AAWhC,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;IACvB,QAAQ,CAAC,MAAM,EAAE,GAAG,EAAE;QACpB,IAAI,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAChD,MAAM,MAAM,GAAG,EAAE,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAW,CAAC,CAAC;YAE7C,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,MAAM,KAAK,GAAW,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAEtC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChC,oDAAoD;gBACpD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QACtB,IAAI,CAAC,uCAAuC,EAAE,GAAG,EAAE;YACjD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;YACnC,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,KAAK,CAAC,CAAC;YAE9D,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,8DAA8D;gBAC9D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;gBAC9C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;gBACzD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAC1B,IAAI,CAAC,uCAAuC,EAAE,GAAG,EAAE;YACjD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;YACnC,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;YAE/B,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;gBAClD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC5C,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,uCAAuC,EAAE,GAAG,EAAE;YACjD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC5D,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;YAE/B,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChD,8DAA8D;gBAC9D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;gBAC9C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACtC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,gCAAgC,EAAE,GAAG,EAAE;YAC1C,MAAM,MAAM,GAAG,QAAQ,CAAC,sBAA0C,CAAC,CAAC;YAEpE,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAC9B,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;gBACf,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC;YACpD,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;QACxB,IAAI,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAW,CAAC,CAAC,CAAC;YACzE,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;YAEnC,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,MAAM,KAAK,GAAW,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAEtC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChC,oDAAoD;gBACpD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC5D,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACpD,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;YAEnC,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;gBAC9C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACtC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAC5B,IAAI,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,aAAa,GAAG,UAAU,CAC9B,CAAC,SAAS,CAAC,EACX,OAAO,CAAC,OAAO,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAW,CAAC,CAC3C,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;YAEnC,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,MAAM,KAAK,GAAW,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAEtC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChC,oDAAoD;gBACpD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC5D,MAAM,aAAa,GAAG,UAAU,CAAC,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YACvE,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;YAEnC,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChD,8DAA8D;gBAC9D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;gBAC9C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACtC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,wCAAwC,EAAE,KAAK,IAAI,EAAE;YACxD,MAAM,YAAY,GAAG,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;YAEnE,MAAM,MAAM,CACV,UAAU,CAAC,CAAC,WAAW,CAAC,EAAE,OAAO,CAAC,MAAM,CAAC,YAAY,CAAC,CAAC,CACxD,CAAC,OAAO,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QACzB,IAAI,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,aAAa,GAAG,OAAO,CAC3B,KAAK,EAAE,IAAY,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EACtC,QAAQ,CACT,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;YAEnC,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,MAAM,KAAK,GAAW,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAEtC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChC,oDAAoD;gBACpD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC5D,MAAM,aAAa,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;YAC3D,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;YAEnC,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;gBAC9C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACtC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,iCAAiC,EAAE,KAAK,IAAI,EAAE;YACjD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,YAAY,CAAC,CAAC;YACtC,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,KAAK,IAAwB,EAAE;gBAC1D,MAAM,KAAK,CAAC;YACd,CAAC,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC;gBACf,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC5C,CAAC;iBAAM,CAAC;gBACN,MAAM,IAAI,MAAM,CAAC,sBAAsB,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,IAAI,CAAC,mDAAmD,EAAE,KAAK,IAAI,EAAE;YACnE,MAAM,aAAa,GAAG,WAAW,CAC/B,CAAC,SAAS,CAAC,EACX,KAAK,EAAE,IAAY,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EACtC,QAAQ,CACT,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;YAEnC,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,MAAM,KAAK,GAAW,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAEtC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChC,oDAAoD;gBACpD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;YACpE,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC5D,MAAM,aAAa,GAAG,WAAW,CAC/B,CAAC,WAAW,CAAC,EACb,GAAuB,EAAE,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAChD,CAAC;YACF,MAAM,MAAM,GAAG,MAAM,aAAa,CAAC;YAEnC,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChD,8DAA8D;gBAC9D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;gBAC9C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACtC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,IAAI,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAChD,MAAM,MAAM,GAAG,WAAW,CAAC,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC;YAEvE,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,MAAM,KAAK,GAAW,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAEtC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChC,oDAAoD;gBACpD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,uCAAuC,EAAE,KAAK,IAAI,EAAE;YACvD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC5D,MAAM,MAAM,GAAG,WAAW,CAAC,GAAG,EAAE;gBAC9B,MAAM,KAAK,CAAC;YACd,CAAC,CAAC,CAAC;YAEH,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;gBAC9C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACtC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,mBAAmB,EAAE,GAAG,EAAE;QACjC,IAAI,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAChD,MAAM,MAAM,GAAG,eAAe,CAC5B,CAAC,SAAS,CAAC,EACX,CAAC,IAAY,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAChC,QAAQ,CACT,CAAC;YAEF,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,MAAM,KAAK,GAAW,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;gBAEtC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChC,oDAAoD;gBACpD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC;YAC3C,CAAC;iBAAM,CAAC;gBACN,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,uCAAuC,EAAE,GAAG,EAAE;YACjD,MAAM,KAAK,GAAG,IAAI,MAAM,CAAC,WAAW,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;YAC5D,MAAM,MAAM,GAAG,eAAe,CAAC,CAAC,WAAW,CAAC,EAAE,GAAc,EAAE;gBAC5D,MAAM,KAAK,CAAC;YACd,CAAC,CAAC,CAAC;YAEH,IAAI,MAAM,CAAC,EAAE,EAAE,CAAC;gBACd,iDAAiD;gBACjD,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,aAAa,EAAE,CAAC;YACvC,CAAC;iBAAM,CAAC;gBACN,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAChD,8DAA8D;gBAC9D,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;gBAC9C,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YACtC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -0,0 +1,149 @@
+{
+  "metapak": {
+    "configs": [
+      "main",
+      "readme",
+      "tsesm",
+      "eslint",
+      "jest",
+      "codeclimate",
+      "ghactions",
+      "jsdocs"
+    ],
+    "data": {
+      "files": "'src/**/*.ts'",
+      "testsFiles": "'src/**/*.test.ts'",
+      "distFiles": "'dist/**/*.js'",
+      "ignore": [
+        "dist"
+      ],
+      "bundleFiles": [
+        "dist",
+        "src"
+      ]
+    }
+  },
+  "name": "zresult",
+  "version": "1.0.0",
+  "description": "Wrap errors into results with that simple library.",
+  "scripts": {
+    "build": "rimraf 'dist' && tsc --outDir dist",
+    "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s && git add CHANGELOG.md",
+    "cli": "env NODE_ENV=${NODE_ENV:-cli}",
+    "commitlint": "commitlint",
+    "cover": "node --run jest -- --coverage",
+    "doc": "echo \"# API\" > API.md; jsdoc2md 'dist/**/*.js' >> API.md && git add API.md",
+    "format": "node --run prettier",
+    "jest": "NODE_OPTIONS=--experimental-vm-modules NODE_ENV=test jest",
+    "lint": "eslint 'src/**/*.ts'",
+    "metapak": "metapak",
+    "precommit": "node --run test && node --run lint && node --run build && node --run doc && node --run metapak -- -s",
+    "prettier": "prettier --write 'src/**/*.ts'",
+    "preversion": "node --run test && node --run lint && node --run build && node --run doc && node --run metapak -- -s",
+    "rebuild": "swc ./src -s -d dist -C jsc.target=es2022",
+    "test": "node --run jest",
+    "version": "node --run changelog"
+  },
+  "engines": {
+    "node": ">=24.14.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/nfroidure/zresult.git"
+  },
+  "keywords": [
+    "error",
+    "why",
+    "better"
+  ],
+  "author": {
+    "name": "Nicolas Froidure",
+    "email": "nicolas.froidure@insertafter.com",
+    "url": "http://insertafter.com/en/index.html"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/nfroidure/zresult/issues"
+  },
+  "dependencies": {
+    "yerror": "^11.0.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^20.5.0",
+    "@commitlint/config-conventional": "^20.5.0",
+    "@eslint/js": "^10.0.1",
+    "@swc/cli": "^0.8.1",
+    "@swc/core": "^1.15.24",
+    "@swc/jest": "^0.2.39",
+    "conventional-changelog": "^7.2.0",
+    "eslint": "^10.2.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jest": "^29.15.1",
+    "eslint-plugin-prettier": "^5.5.5",
+    "jest": "^30.3.0",
+    "jsdoc-to-markdown": "^9.1.3",
+    "metapak": "^7.1.0",
+    "metapak-nfroidure": "22.1.1",
+    "prettier": "^3.8.1",
+    "rimraf": "^6.1.3",
+    "typescript": "^6.0.2",
+    "typescript-eslint": "^8.58.0"
+  },
+  "contributors": [],
+  "files": [
+    "dist",
+    "src",
+    "LICENSE",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "prettier": {
+    "semi": true,
+    "printWidth": 80,
+    "singleQuote": true,
+    "trailingComma": "all",
+    "proseWrap": "always"
+  },
+  "funding": {
+    "type": "individual",
+    "url": "https://github.com/sponsors/nfroidure"
+  },
+  "overrides": {
+    "typescript-eslint": {
+      "typescript": "^6"
+    },
+    "@typescript-eslint/eslint-plugin": {
+      "typescript": "^6"
+    },
+    "@typescript-eslint/parser": {
+      "typescript": "^6"
+    }
+  },
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "jest": {
+    "coverageReporters": [
+      "lcov"
+    ],
+    "testPathIgnorePatterns": [
+      "/node_modules/"
+    ],
+    "roots": [
+      "<rootDir>/src"
+    ],
+    "transform": {
+      "^.+\\.tsx?$": [
+        "@swc/jest",
+        {}
+      ]
+    },
+    "testEnvironment": "node",
+    "moduleNameMapper": {
+      "(.+)\\.js": "$1"
+    },
+    "extensionsToTreatAsEsm": [
+      ".ts"
+    ]
+  }
+}

package/src/index.test.ts

@@ -0,0 +1,336 @@
+import { describe, test, expect } from '@jest/globals';
+import {
+  ok,
+  fail,
+  failWith,
+  settle,
+  settleFrom,
+  attempt,
+  attemptFrom,
+  attemptSync,
+  attemptSyncFrom,
+} from './index.js';
+import { YError } from 'yerror';
+
+declare module 'yerror' {
+  interface YErrorRegistry {
+    E_ERROR: `arg${number}`[];
+    E_ERROR_1: [string, string];
+    E_ERROR_2: [`arg2.1`, `arg2.2`];
+    E_ERROR_3: [`arg3.1`, `arg3.2`];
+  }
+}
+
+describe('zresult', () => {
+  describe('ok()', () => {
+    test('should produce a result with a value', () => {
+      const result = ok({ my: 'result' } as const);
+
+      if (result.ok) {
+        const value: string = result.value.my;
+
+        expect(value).toEqual('result');
+        // @ts-expect-error : expect error if type is casted
+        expect(result.value.not).toBeUndefined();
+      } else {
+        // @ts-expect-error : expect error since no value
+        expect(result.value).toBeUndefined();
+      }
+    });
+  });
+
+  describe('fail()', () => {
+    test('should produce a result with an error', () => {
+      const error = new Error('E_AOUCH');
+      const result = fail('E_ERROR_2', ['arg2.1', 'arg2.2'], error);
+
+      if (result.ok) {
+        // @ts-expect-error : expect error since no error
+        expect(result.error).toBeUndefined();
+      } else {
+        // @ts-expect-error : expect error since nothing at this index
+        expect(result.error.debug[2]).toBeUndefined();
+        expect(result.error.debug).toEqual([`arg2.1`, `arg2.2`]);
+        expect(result.error.cause).toEqual(error);
+      }
+    });
+  });
+
+  describe('failWith()', () => {
+    test('should produce a result with an error', () => {
+      const error = new Error('E_AOUCH');
+      const result = failWith(error);
+
+      if (result.ok) {
+        // @ts-expect-error : expect error since no error
+        expect(result.error).toBeUndefined();
+      } else {
+        expect(result.error.code).toEqual('E_UNEXPECTED');
+        expect(result.error.cause).toEqual(error);
+      }
+    });
+
+    test('should produce a result with a yerror', () => {
+      const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+      const result = failWith(error);
+
+      if (result.ok) {
+        // @ts-expect-error : expect error since no error
+        expect(result.error).toBeUndefined();
+      } else {
+        expect(result.error.debug[1]).toEqual('arg2.2');
+        // @ts-expect-error : expect error since nothing at this index
+        expect(result.error.debug[2]).toBeUndefined();
+        expect(result.error).toEqual(error);
+      }
+    });
+
+    test('should handle non-error throws', () => {
+      const result = failWith('Something went wrong' as unknown as Error);
+
+      expect(result.ok).toBe(false);
+      if (!result.ok) {
+        expect(result.error.code).toEqual('E_UNEXPECTED');
+      }
+    });
+  });
+
+  describe('settle()', () => {
+    test('should produce a result with a promise of a value', async () => {
+      const resultPromise = settle(Promise.resolve({ my: 'result' } as const));
+      const result = await resultPromise;
+
+      if (result.ok) {
+        const value: string = result.value.my;
+
+        expect(value).toEqual('result');
+        // @ts-expect-error : expect error if type is casted
+        expect(result.value.not).toBeUndefined();
+      } else {
+        // @ts-expect-error : expect error since no value
+        expect(result.value).toBeUndefined();
+      }
+    });
+
+    test('should produce a result with a promise of an error', async () => {
+      const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+      const resultPromise = settle(Promise.reject(error));
+      const result = await resultPromise;
+
+      if (result.ok) {
+        // @ts-expect-error : expect error since no error
+        expect(result.error).toBeUndefined();
+      } else {
+        expect(result.error.debug[1]).toEqual('arg2.2');
+        expect(result.error.debug[2]).toBeUndefined();
+        expect(result.error).toEqual(error);
+      }
+    });
+  });
+
+  describe('settleFrom()', () => {
+    test('should produce a result with a promise of a value', async () => {
+      const resultPromise = settleFrom(
+        ['E_ERROR'],
+        Promise.resolve({ my: 'result' } as const),
+      );
+      const result = await resultPromise;
+
+      if (result.ok) {
+        const value: string = result.value.my;
+
+        expect(value).toEqual('result');
+        // @ts-expect-error : expect error if type is casted
+        expect(result.value.not).toBeUndefined();
+      } else {
+        // @ts-expect-error : expect error since no value
+        expect(result.value).toBeUndefined();
+      }
+    });
+
+    test('should produce a result with a promise of an error', async () => {
+      const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+      const resultPromise = settleFrom(['E_ERROR_2'], Promise.reject(error));
+      const result = await resultPromise;
+
+      if (result.ok) {
+        // @ts-expect-error : expect error since no error
+        expect(result.error).toBeUndefined();
+      } else {
+        expect(result.error.debug[1]).toEqual('arg2.2');
+        // @ts-expect-error : expect error since nothing at this index
+        expect(result.error.debug[2]).toBeUndefined();
+        expect(result.error).toEqual(error);
+      }
+    });
+
+    test('should let unknown errors pass through', async () => {
+      const unknownError = new YError('E_ERROR_3', ['arg3.1', 'arg3.2']);
+
+      await expect(
+        settleFrom(['E_ERROR_2'], Promise.reject(unknownError)),
+      ).rejects.toThrow(unknownError);
+    });
+  });
+
+  describe('attempt()', () => {
+    test('should produce a result with a promise of a value', async () => {
+      const resultPromise = attempt(
+        async (test: string) => ({ my: test }),
+        'result',
+      );
+      const result = await resultPromise;
+
+      if (result.ok) {
+        const value: string = result.value.my;
+
+        expect(value).toEqual('result');
+        // @ts-expect-error : expect error if type is casted
+        expect(result.value.not).toBeUndefined();
+      } else {
+        // @ts-expect-error : expect error since no value
+        expect(result.value).toBeUndefined();
+      }
+    });
+
+    test('should produce a result with a promise of an error', async () => {
+      const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+      const resultPromise = attempt(() => Promise.reject(error));
+      const result = await resultPromise;
+
+      if (result.ok) {
+        // @ts-expect-error : expect error since no error
+        expect(result.error).toBeUndefined();
+      } else {
+        expect(result.error.debug[1]).toEqual('arg2.2');
+        expect(result.error.debug[2]).toBeUndefined();
+        expect(result.error).toEqual(error);
+      }
+    });
+
+    test('should catch synchronous throws', async () => {
+      const error = new Error('Sync crash');
+      const result = await attempt(async (): Promise<undefined> => {
+        throw error;
+      });
+
+      if (!result.ok) {
+        expect(result.error.cause).toEqual(error);
+      } else {
+        throw new YError('E_UNEXPECTED_SUCCESS');
+      }
+    });
+  });
+
+  describe('attemptFrom()', () => {
+    test('should produce a result with a promise of a value', async () => {
+      const resultPromise = attemptFrom(
+        ['E_ERROR'],
+        async (test: string) => ({ my: test }),
+        'result',
+      );
+      const result = await resultPromise;
+
+      if (result.ok) {
+        const value: string = result.value.my;
+
+        expect(value).toEqual('result');
+        // @ts-expect-error : expect error if type is casted
+        expect(result.value.not).toBeUndefined();
+      } else {
+        // @ts-expect-error : expect error since no value
+        expect(result.value).toBeUndefined();
+      }
+    });
+
+    test('should produce a result with a promise of an error', async () => {
+      const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+      const resultPromise = attemptFrom(
+        ['E_ERROR_2'],
+        (): Promise<undefined> => Promise.reject(error),
+      );
+      const result = await resultPromise;
+
+      if (result.ok) {
+        // @ts-expect-error : expect error since no error
+        expect(result.error).toBeUndefined();
+      } else {
+        expect(result.error.debug[1]).toEqual('arg2.2');
+        // @ts-expect-error : expect error since nothing at this index
+        expect(result.error.debug[2]).toBeUndefined();
+        expect(result.error).toEqual(error);
+      }
+    });
+  });
+
+  describe('attemptSync()', () => {
+    test('should produce a result with a value', () => {
+      const result = attemptSync((test: string) => ({ my: test }), 'result');
+
+      if (result.ok) {
+        const value: string = result.value.my;
+
+        expect(value).toEqual('result');
+        // @ts-expect-error : expect error if type is casted
+        expect(result.value.not).toBeUndefined();
+      } else {
+        // @ts-expect-error : expect error since no value
+        expect(result.value).toBeUndefined();
+      }
+    });
+
+    test('should produce a result with an error', async () => {
+      const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+      const result = attemptSync(() => {
+        throw error;
+      });
+
+      if (result.ok) {
+        // @ts-expect-error : expect error since no error
+        expect(result.error).toBeUndefined();
+      } else {
+        expect(result.error.debug[1]).toEqual('arg2.2');
+        expect(result.error.debug[2]).toBeUndefined();
+        expect(result.error).toEqual(error);
+      }
+    });
+  });
+
+  describe('attemptSyncFrom()', () => {
+    test('should produce a result with a value', () => {
+      const result = attemptSyncFrom(
+        ['E_ERROR'],
+        (test: string) => ({ my: test }),
+        'result',
+      );
+
+      if (result.ok) {
+        const value: string = result.value.my;
+
+        expect(value).toEqual('result');
+        // @ts-expect-error : expect error if type is casted
+        expect(result.value.not).toBeUndefined();
+      } else {
+        // @ts-expect-error : expect error since no value
+        expect(result.value).toBeUndefined();
+      }
+    });
+
+    test('should produce a result with an error', () => {
+      const error = new YError('E_ERROR_2', ['arg2.1', 'arg2.2']);
+      const result = attemptSyncFrom(['E_ERROR_2'], (): undefined => {
+        throw error;
+      });
+
+      if (result.ok) {
+        // @ts-expect-error : expect error since no error
+        expect(result.error).toBeUndefined();
+      } else {
+        expect(result.error.debug[1]).toEqual('arg2.2');
+        // @ts-expect-error : expect error since nothing at this index
+        expect(result.error.debug[2]).toBeUndefined();
+        expect(result.error).toEqual(error);
+      }
+    });
+  });
+});

package/src/index.ts

@@ -0,0 +1,157 @@
+import {
+  type YErrorDebug,
+  type YErrorRegistry,
+  looksLikeAYError,
+  YError,
+  hasYErrorCode,
+} from 'yerror';
+
+/** A type to encapsulate a result that can either be
+ * failure or a success  */
+export type Result<T, E extends Error | YError> =
+  | { readonly ok: true; readonly value: T }
+  | { readonly ok: false; readonly error: E };
+
+/** Create a successful result */
+export function ok<T>(value: T): Result<T, never> {
+  return {
+    ok: true,
+    value,
+  };
+}
+
+/** Create a failure result using a YError code and debug values */
+export function fail<C extends keyof YErrorRegistry>(
+  code: C,
+  debug: YErrorDebug<C>,
+  error?: Error,
+): Result<never, YError<C>> {
+  return {
+    ok: false,
+    error: new YError(code, debug, { cause: error }),
+  };
+}
+
+/** Wrap an existing error into a failure result */
+export function failWith<E extends Error | YError>(
+  error: E,
+): Result<
+  never,
+  E extends YError<infer C> ? YError<C> : YError<'E_UNEXPECTED'>
+> {
+  return {
+    ok: false,
+    error: (looksLikeAYError(error)
+      ? error
+      : new YError('E_UNEXPECTED', [], { cause: error })) as E extends YError<
+      infer C
+    >
+      ? YError<C>
+      : YError<'E_UNEXPECTED'>,
+  };
+}
+
+/** Transform a Promise into a Result catching any error */
+export async function settle<T>(
+  promise: Promise<T>,
+): Promise<Result<T, YError>> {
+  try {
+    const value = await promise;
+
+    return ok(value);
+  } catch (err) {
+    return failWith(YError.cast(err as Error));
+  }
+}
+
+/** Transform a Promise into a Result catching only known
+ * errors and letting unknown pass through */
+export async function settleFrom<C extends keyof YErrorRegistry, T>(
+  codes: C[],
+  promise: Promise<T>,
+): Promise<Result<T, YError<C>>> {
+  try {
+    const value = await promise;
+
+    return ok(value);
+  } catch (err) {
+    for (const code of codes) {
+      if (hasYErrorCode(err, code)) {
+        return failWith(err);
+      }
+    }
+    throw err;
+  }
+}
+
+/** Runs an asynchronous function and provides a Result catching
+ * any error */
+export async function attempt<
+  T,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  A extends any[],
+>(fn: (...args: A) => Promise<T>, ...args: A): Promise<Result<T, YError>> {
+  try {
+    return ok(await fn(...args));
+  } catch (err) {
+    return failWith(YError.cast(err as Error));
+  }
+}
+
+/** Runs an asynchronous function and provides a Result catching
+ * only known errors and letting unknown pass through */
+export async function attemptFrom<
+  C extends keyof YErrorRegistry,
+  T,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  A extends any[],
+>(
+  codes: C[],
+  fn: (...args: A) => Promise<T>,
+  ...args: A
+): Promise<Result<T, YError<C>>> {
+  try {
+    return ok(await fn(...args));
+  } catch (err) {
+    for (const code of codes) {
+      if (hasYErrorCode(err, code)) {
+        return failWith(err);
+      }
+    }
+    throw err;
+  }
+}
+
+/** Runs a synchronous function and provides a Result catching
+ *  any error */
+export function attemptSync<
+  T,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  A extends any[],
+>(fn: (...args: A) => T, ...args: A): Result<T, YError> {
+  try {
+    return ok(fn(...args));
+  } catch (err) {
+    return failWith(YError.cast(err as Error));
+  }
+}
+
+/** Runs a synchronous function and provides a Result catching
+ *  only known errors and letting unknown pass through */
+export function attemptSyncFrom<
+  C extends keyof YErrorRegistry,
+  T,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  A extends any[],
+>(codes: C[], fn: (...args: A) => T, ...args: A): Result<T, YError<C>> {
+  try {
+    return ok(fn(...args));
+  } catch (err) {
+    for (const code of codes) {
+      if (hasYErrorCode(err, code)) {
+        return failWith(err);
+      }
+    }
+    throw err;
+  }
+}