@zokugun/xtry 0.7.2 → 0.8.0

package/README.md

@@ -174,6 +174,27 @@ All helpers:
 - execute the supplied function and capture thrown values;
 - call the optional `handler` before turning that value into `err(error)`;
 
+### xtryify helpers
+
+`xtryify*` helpers turn any function into a reusable wrapper that always yields a `Result`, saving you from retyping `xtry(…)` every time you call it.
+
+```typescript
+import { xtryifyAsync, xtryifySync } from '@zokugun/xtry'
+
+const fetchUserSafely = xtryifyAsync((id: string) => fetch(`/users/${id}`).then(r => r.json()));
+const parseConfig = xtryifySync(() => JSON.parse(readFileSync('config.json', 'utf8')));
+
+const userResult = await fetchUserSafely('42');
+const configResult = parseConfig();
+```
+
+Available variants mirror the regular helpers:
+
+- `xtryifySync(fn)` and `xtryifyAsync(fn)` return new functions that forward arguments to `fn` and capture thrown/errors as `Result` objects.
+- `xtryifySyncIterable(fn)` and `xtryifyAsyncIterable(fn)` wrap functions that return iterables/async iterables, yielding streams of `Result` values.
+
+Because the returned function already encapsulates the try/catch logic, you can share it across modules (e.g., inject into DI containers or export once for common utilities) while keeping strong `Result` typing for every call site.
+
 ### Partial helpers
 
 ```typescript

package/lib/cjs/async.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.xtrySyncIterable = exports.xtrySync = exports.xtryIterable = exports.xtry = exports.xtryUnknown = exports.toStringFailure = exports.stringifyError = exports.OK_FALSE = exports.OK_TRUE = exports.OK_NULL = exports.OK = exports.err = exports.ok = exports.YOK_FALSE = exports.YOK_TRUE = exports.YOK_NULL = exports.YOK = exports.yep = exports.yresSync = exports.yres = exports.yresUnknown = exports.yerr = exports.yok = exports.xdeferSync = exports.xdefer = exports.xdeferUnknown = void 0;
+exports.xtryifySyncIterable = exports.xtryifySync = exports.xtryifyIterable = exports.xtryify = exports.xtrySyncIterable = exports.xtrySync = exports.xtryIterable = exports.xtry = exports.xtryUnknown = exports.toStringFailure = exports.stringifyError = exports.OK_FALSE = exports.OK_TRUE = exports.OK_NULL = exports.OK = exports.err = exports.ok = exports.YOK_FALSE = exports.YOK_TRUE = exports.YOK_NULL = exports.YOK = exports.yep = exports.yresSync = exports.yres = exports.yresUnknown = exports.yerr = exports.yok = exports.xdeferSync = exports.xdefer = exports.xdeferUnknown = void 0;
 var defer_js_1 = require("./defer.cjs");
 Object.defineProperty(exports, "xdeferUnknown", { enumerable: true, get: function () { return defer_js_1.xdefer; } });
 Object.defineProperty(exports, "xdefer", { enumerable: true, get: function () { return defer_js_1.xdeferAsync; } });
@@ -33,3 +33,8 @@ Object.defineProperty(exports, "xtry", { enumerable: true, get: function () { re
 Object.defineProperty(exports, "xtryIterable", { enumerable: true, get: function () { return try_js_1.xtryAsyncIterable; } });
 Object.defineProperty(exports, "xtrySync", { enumerable: true, get: function () { return try_js_1.xtrySync; } });
 Object.defineProperty(exports, "xtrySyncIterable", { enumerable: true, get: function () { return try_js_1.xtrySyncIterable; } });
+var tryify_js_1 = require("./tryify.cjs");
+Object.defineProperty(exports, "xtryify", { enumerable: true, get: function () { return tryify_js_1.xtryifyAsync; } });
+Object.defineProperty(exports, "xtryifyIterable", { enumerable: true, get: function () { return tryify_js_1.xtryifyAsyncIterable; } });
+Object.defineProperty(exports, "xtryifySync", { enumerable: true, get: function () { return tryify_js_1.xtryifySync; } });
+Object.defineProperty(exports, "xtryifySyncIterable", { enumerable: true, get: function () { return tryify_js_1.xtryifySyncIterable; } });

package/lib/cjs/async.d.cts

@@ -7,3 +7,5 @@ export { ok, err, OK, OK_NULL, OK_TRUE, OK_FALSE } from './result.cjs';
 export { stringifyError } from './stringify-error.cjs';
 export { toStringFailure } from './to-string-failure.cjs';
 export { xtry as xtryUnknown, xtryAsync as xtry, xtryAsyncIterable as xtryIterable, xtrySync, xtrySyncIterable } from './try.cjs';
+export type { AsyncIteratableResult, AsyncIteratorElement, AsyncResult, SyncIteratableResult, SyncIteratorElement, SyncResult } from './tryify.cjs';
+export { xtryifyAsync as xtryify, xtryifyAsyncIterable as xtryifyIterable, xtryifySync, xtryifySyncIterable } from './tryify.cjs';

package/lib/cjs/index.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.xtrySyncIterable = exports.xtrySync = exports.xtryAsyncIterable = exports.xtryAsync = exports.xtry = exports.toStringFailure = exports.stringifyError = exports.OK_FALSE = exports.OK_TRUE = exports.OK_NULL = exports.OK = exports.err = exports.ok = exports.YOK_FALSE = exports.YOK_TRUE = exports.YOK_NULL = exports.YOK = exports.yep = exports.yresSync = exports.yresAsync = exports.yres = exports.yerr = exports.yok = exports.xdeferSync = exports.xdeferAsync = exports.xdefer = void 0;
+exports.xtryifySyncIterable = exports.xtryifySync = exports.xtryifyAsyncIterable = exports.xtryifyAsync = exports.xtrySyncIterable = exports.xtrySync = exports.xtryAsyncIterable = exports.xtryAsync = exports.xtry = exports.toStringFailure = exports.stringifyError = exports.OK_FALSE = exports.OK_TRUE = exports.OK_NULL = exports.OK = exports.err = exports.ok = exports.YOK_FALSE = exports.YOK_TRUE = exports.YOK_NULL = exports.YOK = exports.yep = exports.yresSync = exports.yresAsync = exports.yres = exports.yerr = exports.yok = exports.xdeferSync = exports.xdeferAsync = exports.xdefer = void 0;
 var defer_js_1 = require("./defer.cjs");
 Object.defineProperty(exports, "xdefer", { enumerable: true, get: function () { return defer_js_1.xdefer; } });
 Object.defineProperty(exports, "xdeferAsync", { enumerable: true, get: function () { return defer_js_1.xdeferAsync; } });
@@ -33,3 +33,8 @@ Object.defineProperty(exports, "xtryAsync", { enumerable: true, get: function ()
 Object.defineProperty(exports, "xtryAsyncIterable", { enumerable: true, get: function () { return try_js_1.xtryAsyncIterable; } });
 Object.defineProperty(exports, "xtrySync", { enumerable: true, get: function () { return try_js_1.xtrySync; } });
 Object.defineProperty(exports, "xtrySyncIterable", { enumerable: true, get: function () { return try_js_1.xtrySyncIterable; } });
+var tryify_js_1 = require("./tryify.cjs");
+Object.defineProperty(exports, "xtryifyAsync", { enumerable: true, get: function () { return tryify_js_1.xtryifyAsync; } });
+Object.defineProperty(exports, "xtryifyAsyncIterable", { enumerable: true, get: function () { return tryify_js_1.xtryifyAsyncIterable; } });
+Object.defineProperty(exports, "xtryifySync", { enumerable: true, get: function () { return tryify_js_1.xtryifySync; } });
+Object.defineProperty(exports, "xtryifySyncIterable", { enumerable: true, get: function () { return tryify_js_1.xtryifySyncIterable; } });

package/lib/cjs/index.d.cts

@@ -7,3 +7,5 @@ export { ok, err, OK, OK_NULL, OK_TRUE, OK_FALSE } from './result.cjs';
 export { stringifyError } from './stringify-error.cjs';
 export { toStringFailure } from './to-string-failure.cjs';
 export { xtry, xtryAsync, xtryAsyncIterable, xtrySync, xtrySyncIterable } from './try.cjs';
+export type { AsyncIteratableResult, AsyncIteratorElement, AsyncResult, SyncIteratableResult, SyncIteratorElement, SyncResult } from './tryify.cjs';
+export { xtryifyAsync, xtryifyAsyncIterable, xtryifySync, xtryifySyncIterable } from './tryify.cjs';

package/lib/cjs/sync.cjs

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.xtryIterable = exports.xtry = exports.xtryAsyncIterable = exports.xtryAsync = exports.xtryUnknown = exports.toStringFailure = exports.stringifyError = exports.OK_FALSE = exports.OK_TRUE = exports.OK_NULL = exports.OK = exports.err = exports.ok = exports.YOK_FALSE = exports.YOK_TRUE = exports.YOK_NULL = exports.YOK = exports.yep = exports.yres = exports.yresAsync = exports.yresUnknown = exports.yerr = exports.yok = exports.xdefer = exports.xdeferAsync = exports.xdeferUnknown = void 0;
+exports.xtryifyIterable = exports.xtryify = exports.xtryifyAsyncIterable = exports.xtryifyAsync = exports.xtryIterable = exports.xtry = exports.xtryAsyncIterable = exports.xtryAsync = exports.xtryUnknown = exports.toStringFailure = exports.stringifyError = exports.OK_FALSE = exports.OK_TRUE = exports.OK_NULL = exports.OK = exports.err = exports.ok = exports.YOK_FALSE = exports.YOK_TRUE = exports.YOK_NULL = exports.YOK = exports.yep = exports.yres = exports.yresAsync = exports.yresUnknown = exports.yerr = exports.yok = exports.xdefer = exports.xdeferAsync = exports.xdeferUnknown = void 0;
 var defer_js_1 = require("./defer.cjs");
 Object.defineProperty(exports, "xdeferUnknown", { enumerable: true, get: function () { return defer_js_1.xdefer; } });
 Object.defineProperty(exports, "xdeferAsync", { enumerable: true, get: function () { return defer_js_1.xdeferAsync; } });
@@ -33,3 +33,8 @@ Object.defineProperty(exports, "xtryAsync", { enumerable: true, get: function ()
 Object.defineProperty(exports, "xtryAsyncIterable", { enumerable: true, get: function () { return try_js_1.xtryAsyncIterable; } });
 Object.defineProperty(exports, "xtry", { enumerable: true, get: function () { return try_js_1.xtrySync; } });
 Object.defineProperty(exports, "xtryIterable", { enumerable: true, get: function () { return try_js_1.xtrySyncIterable; } });
+var tryify_js_1 = require("./tryify.cjs");
+Object.defineProperty(exports, "xtryifyAsync", { enumerable: true, get: function () { return tryify_js_1.xtryifyAsync; } });
+Object.defineProperty(exports, "xtryifyAsyncIterable", { enumerable: true, get: function () { return tryify_js_1.xtryifyAsyncIterable; } });
+Object.defineProperty(exports, "xtryify", { enumerable: true, get: function () { return tryify_js_1.xtryifySync; } });
+Object.defineProperty(exports, "xtryifyIterable", { enumerable: true, get: function () { return tryify_js_1.xtryifySyncIterable; } });

package/lib/cjs/sync.d.cts

@@ -7,3 +7,5 @@ export { ok, err, OK, OK_NULL, OK_TRUE, OK_FALSE } from './result.cjs';
 export { stringifyError } from './stringify-error.cjs';
 export { toStringFailure } from './to-string-failure.cjs';
 export { xtry as xtryUnknown, xtryAsync, xtryAsyncIterable, xtrySync as xtry, xtrySyncIterable as xtryIterable } from './try.cjs';
+export type { AsyncIteratableResult, AsyncIteratorElement, AsyncResult, SyncIteratableResult, SyncIteratorElement, SyncResult } from './tryify.cjs';
+export { xtryifyAsync, xtryifyAsyncIterable, xtryifySync as xtryify, xtryifySyncIterable as xtryifyIterable } from './tryify.cjs';

package/lib/cjs/tryify.cjs

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.xtryifyAsync = xtryifyAsync;
+exports.xtryifyAsyncIterable = xtryifyAsyncIterable;
+exports.xtryifySync = xtryifySync;
+exports.xtryifySyncIterable = xtryifySyncIterable;
+const try_js_1 = require("./try.cjs");
+function xtryifyAsync(fn) {
+    return async function (...args) {
+        return (0, try_js_1.xtryAsync)(fn(...args));
+    };
+}
+function xtryifyAsyncIterable(fn) {
+    return function (...args) {
+        return (0, try_js_1.xtryAsyncIterable)(fn(...args));
+    };
+}
+function xtryifySync(fn) {
+    return function (...args) {
+        return (0, try_js_1.xtrySync)(() => fn(...args));
+    };
+}
+function xtryifySyncIterable(fn) {
+    return function (...args) {
+        return (0, try_js_1.xtrySyncIterable)(fn(...args));
+    };
+}

package/lib/cjs/tryify.d.cts

@@ -0,0 +1,16 @@
+import { type Result } from './result.cjs';
+import { type NotPromise } from './utils/types.cjs';
+export type AsyncIteratorElement<T> = T extends Promise<infer P> ? AsyncIteratorElement<P> : T extends AsyncIterator<infer E> ? E : T extends AsyncIterable<infer E> ? E : T extends {
+    [Symbol.asyncIterator]: (...args: unknown[]) => infer I;
+} ? AsyncIteratorElement<I> : unknown;
+export type SyncIteratorElement<T> = T extends Iterator<infer E> ? E : T extends Iterable<infer E> ? E : T extends {
+    [Symbol.iterator]: (...args: unknown[]) => infer I;
+} ? SyncIteratorElement<I> : unknown;
+export type AsyncResult<T extends (...args: unknown[]) => unknown, Err extends Error> = Promise<Result<Awaited<ReturnType<T>>, Err>>;
+export type AsyncIteratableResult<T extends (...args: unknown[]) => unknown, Err extends Error> = AsyncIterable<Result<AsyncIteratorElement<ReturnType<T>>, Err>, unknown, unknown>;
+export type SyncResult<T extends (...args: unknown[]) => NotPromise<unknown>, Err extends Error> = Result<ReturnType<T>, Err>;
+export type SyncIteratableResult<T extends (...args: unknown[]) => unknown, Err extends Error> = Iterable<Result<SyncIteratorElement<ReturnType<T>>, Err>, unknown, unknown>;
+export declare function xtryifyAsync<Fn extends (...args: unknown[]) => Promise<unknown>, Err extends Error>(fn: Fn): (...args: Parameters<Fn>) => AsyncResult<Fn, Err>;
+export declare function xtryifyAsyncIterable<Fn extends (...args: unknown[]) => AsyncIterable<unknown>, Err extends Error>(fn: Fn): (...args: Parameters<Fn>) => AsyncIteratableResult<Fn, Err>;
+export declare function xtryifySync<Fn extends (...args: unknown[]) => NotPromise<unknown>, Err extends Error>(fn: Fn): (...args: Parameters<Fn>) => SyncResult<Fn, Err>;
+export declare function xtryifySyncIterable<Fn extends (...args: unknown[]) => Iterable<unknown>, Err extends Error>(fn: Fn): (...args: Parameters<Fn>) => SyncIteratableResult<Fn, Err>;

package/lib/esm/async.d.mts

@@ -7,3 +7,5 @@ export { ok, err, OK, OK_NULL, OK_TRUE, OK_FALSE } from './result.mjs';
 export { stringifyError } from './stringify-error.mjs';
 export { toStringFailure } from './to-string-failure.mjs';
 export { xtry as xtryUnknown, xtryAsync as xtry, xtryAsyncIterable as xtryIterable, xtrySync, xtrySyncIterable } from './try.mjs';
+export type { AsyncIteratableResult, AsyncIteratorElement, AsyncResult, SyncIteratableResult, SyncIteratorElement, SyncResult } from './tryify.mjs';
+export { xtryifyAsync as xtryify, xtryifyAsyncIterable as xtryifyIterable, xtryifySync, xtryifySyncIterable } from './tryify.mjs';

package/lib/esm/async.mjs

@@ -4,3 +4,4 @@ export { ok, err, OK, OK_NULL, OK_TRUE, OK_FALSE } from './result.mjs';
 export { stringifyError } from './stringify-error.mjs';
 export { toStringFailure } from './to-string-failure.mjs';
 export { xtry as xtryUnknown, xtryAsync as xtry, xtryAsyncIterable as xtryIterable, xtrySync, xtrySyncIterable } from './try.mjs';
+export { xtryifyAsync as xtryify, xtryifyAsyncIterable as xtryifyIterable, xtryifySync, xtryifySyncIterable } from './tryify.mjs';

package/lib/esm/index.d.mts

@@ -7,3 +7,5 @@ export { ok, err, OK, OK_NULL, OK_TRUE, OK_FALSE } from './result.mjs';
 export { stringifyError } from './stringify-error.mjs';
 export { toStringFailure } from './to-string-failure.mjs';
 export { xtry, xtryAsync, xtryAsyncIterable, xtrySync, xtrySyncIterable } from './try.mjs';
+export type { AsyncIteratableResult, AsyncIteratorElement, AsyncResult, SyncIteratableResult, SyncIteratorElement, SyncResult } from './tryify.mjs';
+export { xtryifyAsync, xtryifyAsyncIterable, xtryifySync, xtryifySyncIterable } from './tryify.mjs';

package/lib/esm/index.mjs

@@ -4,3 +4,4 @@ export { ok, err, OK, OK_NULL, OK_TRUE, OK_FALSE } from './result.mjs';
 export { stringifyError } from './stringify-error.mjs';
 export { toStringFailure } from './to-string-failure.mjs';
 export { xtry, xtryAsync, xtryAsyncIterable, xtrySync, xtrySyncIterable } from './try.mjs';
+export { xtryifyAsync, xtryifyAsyncIterable, xtryifySync, xtryifySyncIterable } from './tryify.mjs';

package/lib/esm/sync.d.mts

@@ -7,3 +7,5 @@ export { ok, err, OK, OK_NULL, OK_TRUE, OK_FALSE } from './result.mjs';
 export { stringifyError } from './stringify-error.mjs';
 export { toStringFailure } from './to-string-failure.mjs';
 export { xtry as xtryUnknown, xtryAsync, xtryAsyncIterable, xtrySync as xtry, xtrySyncIterable as xtryIterable } from './try.mjs';
+export type { AsyncIteratableResult, AsyncIteratorElement, AsyncResult, SyncIteratableResult, SyncIteratorElement, SyncResult } from './tryify.mjs';
+export { xtryifyAsync, xtryifyAsyncIterable, xtryifySync as xtryify, xtryifySyncIterable as xtryifyIterable } from './tryify.mjs';

package/lib/esm/sync.mjs

@@ -4,3 +4,4 @@ export { ok, err, OK, OK_NULL, OK_TRUE, OK_FALSE } from './result.mjs';
 export { stringifyError } from './stringify-error.mjs';
 export { toStringFailure } from './to-string-failure.mjs';
 export { xtry as xtryUnknown, xtryAsync, xtryAsyncIterable, xtrySync as xtry, xtrySyncIterable as xtryIterable } from './try.mjs';
+export { xtryifyAsync, xtryifyAsyncIterable, xtryifySync as xtryify, xtryifySyncIterable as xtryifyIterable } from './tryify.mjs';

package/lib/esm/tryify.d.mts

@@ -0,0 +1,16 @@
+import { type Result } from './result.mjs';
+import { type NotPromise } from './utils/types.mjs';
+export type AsyncIteratorElement<T> = T extends Promise<infer P> ? AsyncIteratorElement<P> : T extends AsyncIterator<infer E> ? E : T extends AsyncIterable<infer E> ? E : T extends {
+    [Symbol.asyncIterator]: (...args: unknown[]) => infer I;
+} ? AsyncIteratorElement<I> : unknown;
+export type SyncIteratorElement<T> = T extends Iterator<infer E> ? E : T extends Iterable<infer E> ? E : T extends {
+    [Symbol.iterator]: (...args: unknown[]) => infer I;
+} ? SyncIteratorElement<I> : unknown;
+export type AsyncResult<T extends (...args: unknown[]) => unknown, Err extends Error> = Promise<Result<Awaited<ReturnType<T>>, Err>>;
+export type AsyncIteratableResult<T extends (...args: unknown[]) => unknown, Err extends Error> = AsyncIterable<Result<AsyncIteratorElement<ReturnType<T>>, Err>, unknown, unknown>;
+export type SyncResult<T extends (...args: unknown[]) => NotPromise<unknown>, Err extends Error> = Result<ReturnType<T>, Err>;
+export type SyncIteratableResult<T extends (...args: unknown[]) => unknown, Err extends Error> = Iterable<Result<SyncIteratorElement<ReturnType<T>>, Err>, unknown, unknown>;
+export declare function xtryifyAsync<Fn extends (...args: unknown[]) => Promise<unknown>, Err extends Error>(fn: Fn): (...args: Parameters<Fn>) => AsyncResult<Fn, Err>;
+export declare function xtryifyAsyncIterable<Fn extends (...args: unknown[]) => AsyncIterable<unknown>, Err extends Error>(fn: Fn): (...args: Parameters<Fn>) => AsyncIteratableResult<Fn, Err>;
+export declare function xtryifySync<Fn extends (...args: unknown[]) => NotPromise<unknown>, Err extends Error>(fn: Fn): (...args: Parameters<Fn>) => SyncResult<Fn, Err>;
+export declare function xtryifySyncIterable<Fn extends (...args: unknown[]) => Iterable<unknown>, Err extends Error>(fn: Fn): (...args: Parameters<Fn>) => SyncIteratableResult<Fn, Err>;

package/lib/esm/tryify.mjs

@@ -0,0 +1,21 @@
+import { xtryAsync, xtryAsyncIterable, xtrySync, xtrySyncIterable } from './try.mjs';
+export function xtryifyAsync(fn) {
+    return async function (...args) {
+        return xtryAsync(fn(...args));
+    };
+}
+export function xtryifyAsyncIterable(fn) {
+    return function (...args) {
+        return xtryAsyncIterable(fn(...args));
+    };
+}
+export function xtryifySync(fn) {
+    return function (...args) {
+        return xtrySync(() => fn(...args));
+    };
+}
+export function xtryifySyncIterable(fn) {
+    return function (...args) {
+        return xtrySyncIterable(fn(...args));
+    };
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@zokugun/xtry",
 	"description": "simple try/catch wrapper returning Result",
-	"version": "0.7.2",
+	"version": "0.8.0",
 	"author": {
 		"name": "Baptiste Augrain",
 		"email": "daiyam@zokugun.org"