@zokugun/xtry 0.1.0

package/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2025-present Baptiste Augrain
+
+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,104 @@
+[@zokugun/xtry](https://github.com/zokugun/node-xtry)
+==========================================================
+
+[![MIT licensed](https://img.shields.io/badge/license-MIT-blue.svg)](./LICENSE)
+[![NPM Version](https://img.shields.io/npm/v/@zokugun/xtry.svg?colorB=green)](https://www.npmjs.com/package/@zokugun/xtry)
+[![Donation](https://img.shields.io/badge/donate-ko--fi-green)](https://ko-fi.com/daiyam)
+[![Donation](https://img.shields.io/badge/donate-liberapay-green)](https://liberapay.com/daiyam/donate)
+[![Donation](https://img.shields.io/badge/donate-paypal-green)](https://paypal.me/daiyam99)
+
+Simple `try/catch` wrapper returning Result
+
+Getting Started
+---------------
+
+With [node](http://nodejs.org) previously installed:
+
+	npm install @zokugun/xtry
+
+Basic Example
+-------------
+
+```typescript
+import { xatry } from '@zokugun/xtry'
+
+const { fails, value, error } = xatry(somePromise);
+```
+
+Advanced Example
+----------------
+
+```typescript
+import { err, ok, type Result, xatry, xtry } from '@zokugun/xtry'
+
+export type FoobarError = { type: 'FOOBAR'; message: string };
+
+function foobar(): Result<number, FoobarError> {
+    const { fails, value, error } = xatry(somePromise);
+
+    if (fails) {
+        return err({ type: 'FOOBAR', message: 'The promise has failed...' });
+    }
+
+    return ok(value);
+}
+
+function main() {
+    const result = foobar();
+
+    if (result.fails) {
+        console.error(result.error.message);
+        exit(1);
+    }
+
+    console.log(value);
+}
+```
+
+API
+---
+
+```typescript
+type Success<T> = {
+    fails: false;
+    value: T;
+    error: null;
+};
+type Failure<E> = {
+    fails: true;
+    value: null;
+    error: E;
+};
+export type Result<T, E> = Success<T> | Failure<E>;
+export function xtry<T, E>(func: () => Exclude<T, Promise<unknown>>, handler?: ((error: E) => void)): Result<T, E>;
+export async function xatry<T, E>(func: (() => Exclude<T, Promise<unknown>>) | Promise<Exclude<T, Promise<unknown>>>, handler?: ((error: E) => void)): Promise<Result<T, E>>;
+export function ok<T>(value: T): Success<T>;
+export function err<E>(error: E): Failure<E>;
+```
+
+Donations
+---------
+
+Support this project by becoming a financial contributor.
+
+<table>
+    <tr>
+        <td><img src="https://raw.githubusercontent.com/daiyam/assets/master/icons/256/funding_kofi.png" alt="Ko-fi" width="80px" height="80px"></td>
+        <td><a href="https://ko-fi.com/daiyam" target="_blank">ko-fi.com/daiyam</a></td>
+    </tr>
+    <tr>
+        <td><img src="https://raw.githubusercontent.com/daiyam/assets/master/icons/256/funding_liberapay.png" alt="Liberapay" width="80px" height="80px"></td>
+        <td><a href="https://liberapay.com/daiyam/donate" target="_blank">liberapay.com/daiyam/donate</a></td>
+    </tr>
+    <tr>
+        <td><img src="https://raw.githubusercontent.com/daiyam/assets/master/icons/256/funding_paypal.png" alt="PayPal" width="80px" height="80px"></td>
+        <td><a href="https://paypal.me/daiyam99" target="_blank">paypal.me/daiyam99</a></td>
+    </tr>
+</table>
+
+License
+-------
+
+Copyright &copy; 2025-present Baptiste Augrain
+
+Licensed under the [MIT license](https://opensource.org/licenses/MIT).

package/lib/index.d.ts

@@ -0,0 +1,16 @@
+type Success<T> = {
+    fails: false;
+    value: T;
+    error: null;
+};
+type Failure<E> = {
+    fails: true;
+    value: null;
+    error: E;
+};
+export type Result<T, E> = Success<T> | Failure<E>;
+export declare function xtry<T, E>(func: () => Exclude<T, Promise<unknown>>, handler?: ((error: E) => void)): Result<T, E>;
+export declare function xatry<T, E>(func: (() => Exclude<T, Promise<unknown>>) | Promise<Exclude<T, Promise<unknown>>>, handler?: ((error: E) => void)): Promise<Result<T, E>>;
+export declare function ok<T>(value: T): Success<T>;
+export declare function err<E>(error: E): Failure<E>;
+export {};

package/lib/index.js

@@ -0,0 +1,38 @@
+export function xtry(func, handler) {
+    try {
+        const value = func();
+        return ok(value);
+    }
+    catch (error) {
+        if (handler) {
+            handler(error);
+        }
+        return err(error);
+    }
+}
+export async function xatry(func, handler) {
+    try {
+        const value = await (func instanceof Promise ? func : Promise.resolve().then(func));
+        return ok(value);
+    }
+    catch (error) {
+        if (handler) {
+            handler(error);
+        }
+        return err(error);
+    }
+}
+export function ok(value) {
+    return {
+        fails: false,
+        value,
+        error: null,
+    };
+}
+export function err(error) {
+    return {
+        fails: true,
+        value: null,
+        error,
+    };
+}

package/lib/test.d.ts

@@ -0,0 +1,4 @@
+export type FoobarError = {
+    type: 'FOOBAR';
+    message: string;
+};

package/lib/test.js

@@ -0,0 +1,21 @@
+import { err, ok, xatry } from './index.js';
+import { exit } from 'node:process';
+import { readFile } from "fs/promises";
+async function readConfigFile() {
+    return readFile("./config.json", "utf-8").then((data) => JSON.parse(data).PORT);
+}
+async function foobar() {
+    const { fails, value } = await xatry(readConfigFile());
+    if (fails) {
+        return err({ type: 'FOOBAR', message: 'The promise has failed...' });
+    }
+    return ok(value);
+}
+async function main() {
+    const { fails, value } = await xatry(foobar);
+    if (fails) {
+        exit(1);
+    }
+    console.log(value);
+}
+main();

package/package.json

@@ -0,0 +1,62 @@
+{
+	"name": "@zokugun/xtry",
+	"description": "simple try/catch wrapper returning Result",
+	"version": "0.1.0",
+	"author": {
+		"name": "Baptiste Augrain",
+		"email": "daiyam@zokugun.org"
+	},
+	"license": "MIT",
+	"homepage": "https://github.com/zokugun/node-xtry",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/zokugun/node-xtry.git"
+	},
+	"bugs": {
+		"url": "https://github.com/zokugun/node-xtry/issues"
+	},
+	"type": "module",
+	"main": "lib/index.js",
+	"scripts": {
+		"commit": "cz",
+		"compile": "tsc -p src",
+		"lint": "xo",
+		"prepare": "husky; fixpack || true",
+		"prepublishOnly": "npm run compile",
+		"release": "release-it",
+		"test": "tsc -p test && mocha",
+		"test:dev": "mocha",
+		"test:watch": "tsc-watch -p test --onSuccess 'mocha'",
+		"watch:src": "tsc -watch -p src",
+		"watch:test": "tsc-watch -p test"
+	},
+	"dependencies": {},
+	"devDependencies": {
+		"@commitlint/cli": "^19.7.1",
+		"@commitlint/config-conventional": "^19.7.1",
+		"@types/chai": "^5.0.1",
+		"@types/fs-extra": "^11.0.4",
+		"@types/mocha": "^10.0.10",
+		"@types/node": "^20.14.8",
+		"chai": "^5.2.0",
+		"commitizen": "^4.3.1",
+		"eslint-plugin-chai-friendly": "^1.0.1",
+		"fixpack": "^4.0.0",
+		"fs-extra": "^11.3.0",
+		"globby": "^14.1.0",
+		"husky": "^9.1.7",
+		"lint-staged": "^15.4.3",
+		"mocha": "^11.1.0",
+		"release-it": "^18.1.2",
+		"source-map-support": "^0.5.21",
+		"tsc-watch": "^6.3.0",
+		"typescript": "^5.7.3",
+		"xo": "0.60.0"
+	},
+	"keywords": [
+		"catch",
+		"error",
+		"result",
+		"try"
+	]
+}