Merge pull request #6 from LoredDev/changeset-release/main

🦋 Release branch

CHANGELOG.md

@@ -1,17 +1,5 @@
 # lilbetter.js
 
-## 0.1.0
-
-### Minor Changes
-
-- ecfbfc7: Created the tryAsync (tryA) and trySync (tryS) functions, said can be used for wrapping and calling functions that can throw error. Said error can then be handled using in a Go-like fashion.
-
-## 0.0.3
-
-### Patch Changes
-
-- 138dc21: Populated package.json
-
 ## 0.0.2
 
 ### Patch Changes

jsconfig.json

@@ -13,7 +13,7 @@
 		"alwaysStrict": true
 	},
 	"include": [
-		"./src/**/*",
+		"./src/**/*.js",
 		"./test/**/*.js",
 		"./eslint.config.js",
 		"./commitlint.config.cjs"

package.json

@@ -1,61 +1,29 @@
 {
-	"name": "lilbetter.js",
+  "name": "lilbetter.js",
-	"version": "0.1.0",
+  "version": "0.0.2",
-	"description": "",
+  "description": "",
-	"main": "./src/index.js",
+  "main": "./src/index.js",
-	"browser": "./src/index.js",
+  "scripts": {
-	"source": "./src/index.js",
+    "test": "vitest",
-	"module": "./src/index.js",
+    "prepare": "husky install",
-	"homepage": "https://github.com/LoredDev/lilbetter.js",
+    "lint": "eslint .",
-	"repository": {
+    "lint:fix": "eslint . --fix",
-		"type": "git",
+    "release": "changeset publish"
-		"url": "https://github.com/LoredDev/lilbetter.js"
+  },
-	},
+  "type": "module",
-	"exports": {
+  "keywords": [],
-		".": {
+  "author": "",
-			"import": "./src/index.js",
+  "license": "MIT",
-			"default": "./src/index.js",
+  "publishConfig": {
-			"types": "./src/index.d.ts"
+    "access": "public"
-		},
+  },
-		"./try": {
+  "devDependencies": {
-			"import": "./src/try.js",
+    "@changesets/cli": "^2.27.1",
-			"default": "./src/try.js",
+    "@commitlint/config-conventional": "^18.4.4",
-			"types": "./src/try.d.ts"
+    "@commitlint/types": "^18.4.4",
-		}
+    "@eslegant/js": "0.0.0-next-20230910004746",
-	},
+    "eslint": "^8.56.0",
-	"files": [
+    "husky": "^8.0.3",
-		"./src/**/*.js",
+    "vitest": "^1.2.1"
-		"./src/**/*.d.ts"
+  }
-	],
-	"scripts": {
-		"test": "vitest",
-		"prepare": "husky install",
-		"lint": "eslint .",
-		"lint:fix": "eslint . --fix",
-		"release": "changeset publish"
-	},
-	"type": "module",
-	"keywords": [],
-	"author": {
-		"email": "contact.guz013@gmail.com",
-		"name": "Gustavo \"Guz\" L. de Mello",
-		"url": "https://guz.one"
-	},
-	"license": "MIT",
-	"engines": {
-		"node": ">=18",
-		"pnpm": ">=8"
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"devDependencies": {
-		"@changesets/cli": "^2.27.1",
-		"@commitlint/config-conventional": "^18.4.4",
-		"@commitlint/types": "^18.4.4",
-		"@eslegant/js": "0.0.0-next-20230910004746",
-		"eslint": "^8.56.0",
-		"husky": "^8.0.3",
-		"vitest": "^1.2.1"
-	}
 }

src/index.d.ts

@@ -1,3 +0,0 @@
-
-export * from './try.d.ts';
-

src/index.js

@@ -1,3 +1,5 @@
-
+/*
-export * from './try.js';
+ * Placeholder file
-
+ */
+// eslint-disable-next-line no-console
+console.log('Hello, world!');

src/try.d.ts

@@ -1,94 +0,0 @@
-
-/**
- * The WrappedResult type returned by the wrapped function in {@link trySync}
- * and {@link tryAsync}.
- *
- * **If a error occurred, the result is undefined**.
- * If there's not a error, error will be null and the result will be defined.
- */
-type WrappedResult<R> = [R, null] | [undefined, Error];
-
-/**
- * The returned function from {@link tryAsync}.
- *
- * @param  args - The arguments of the function.
- * - The arguments of the wrapped function.
- * @returns
- * - The final tuple containing the Error object (if one occured) and the resulting value.
- */
-type WrappedAsyncFunction<F> = (...args: Parameters<F>) =>
-Promise<WrappedResult<Awaited<ReturnType<F>>>>;
-
-/**
- * Function-sugar/Syntax-sugar for handling functions that can throw errors. Wrapping then
- * into a try-catch block / "curried function" that returns a "tuple as array" of error and
- * value, which can be used for handling the error using a Go-like fashion. **This function
- * is for asynchronous operations,** for synchronous ones, see {@link trySync}.
- *
- * **If there's a error, the result is undefined**.
- * If there's not a error, error will be null and the result will be defined.
- *
- * @param func
- * - The function to be executed.
- * @returns
- * - The function to be immediately called with the wrapped function's arguments.
- * @example
- * const [error, res] = await tryAsync(fetch)("https://example.com");
- * if (error !== null) {
- *   // error handling...
- *   console.log(error);
- * }
- * // continue the logic...
- */
-function tryAsync<
-	F extends (...args: Parameters<F>) => (ReturnType<F> extends Promise
-		? ReturnType<F>
-		: Promise<ReturnType<F>>
-	),
->(func: F): WrappedAsyncFunction<F>;
-
-/**
- * The returned function from {@link trySync}.
- *
- * @param args
- * - The arguments of the wrapped function.
- * @returns
- * - The final tuple containing the Error object (if one occured) and the resulting value.
- */
-type WrappedFunction<F> = (...args: Parameters<F>) =>
-WrappedResult<ReturnType<F>>;
-
-/**
- * Function-sugar/Syntax-sugar for handling functions that can throw errors. Wrapping then
- * into a try-catch block / "curried function" that returns a "tuple as array" of error and
- * value, which can be used for handling the error using a Go-like fashion. **This function
- * is for synchronous operations,** for asynchronous ones, see {@link tryAsync}.
- *
- * **If there's a error, the result is undefined**.
- * If there's not a error, error will be null and the result will be defined.
- *
- * @param func
- * - The function to be executed.
- * @returns
- * - The function to be immediately called with the wrapped function's arguments.
- * @example
- * const [error, json] = trySync(JSON.parse)('{ "hello": "world" }');
- * if (error !== null) {
- *   // error handling...
- *   console.log(error);
- * }
- * // continue the logic...
- */
-function trySync<
-	F extends (...args: Parameters<F>) => ReturnType<F>,
->(func: F): WrappedFunction<F>;
-
-export {
-	type WrappedAsyncFunction,
-	type WrappedFunction,
-	type WrappedResult,
-	tryAsync as tryA,
-	tryAsync,
-	trySync as tryS,
-	trySync,
-};

src/try.js

@@ -1,133 +0,0 @@
-/* eslint-disable no-secrets/no-secrets */
-
-/**
- * The WrappedResult type returned by the wrapped function in {@link trySync}
- * and {@link tryAsync}.
- *
- * **If a error occurred, the result is undefined**.
- * If there's not a error, error will be null and the result will be defined.
- *
- * @typedef {[R, null] | [undefined, Error]} WrappedResult<R>
- * @template R
- */
-
-/**
- * The returned function from {@link tryAsync}.
- *
- * @typedef {(...args: Parameters<F>) => Promise<WrappedResult<Awaited<ReturnType<F>>>>}
- * WrappedAsyncFunction
- * @template {(...args: Parameters<F>) => ReturnType<F>} F
- */
-
-/**
- * Function-sugar/Syntax-sugar for handling functions that can throw errors. Wrapping then
- * into a try-catch block / "curried function" that returns a "tuple as array" of error and
- * value, which can be used for handling the error using a Go-like fashion. **This function
- * is for asynchronous operations,** for synchronous ones, see {@link trySync}.
- *
- * **If there's a error, the result is undefined**.
- * If there's not a error, error will be null and the result will be defined.
- *
- * @template {(...args: Parameters<F>) => Promise<Awaited<ReturnType<F>>>} F
- * @param {F} func
- * - The function to be executed.
- * @returns {WrappedAsyncFunction<F>}
- * - The function to be immediately called with the wrapped function's arguments.
- * @example
- * const [error, res] = await tryAsync(fetch)("https://example.com");
- * if (error !== null) {
- *   // error handling...
- *   console.log(error);
- * }
- * // continue the logic...
- */
-function tryAsync(func) {
-	/**
-	 * The returned function from {@link tryAsync}.
-	 *
-	 * @param {Parameters<F>} args - The arguments of the function.
-	 * - The arguments of the wrapped function.
-	 * @returns {Promise<WrappedResult<Awaited<ReturnType<F>>>>}
-	 * - The final tuple containing the Error object (if one occured) and the resulting value.
-	 */
-	return async (...args) => {
-		try {
-			return [await func(...args), null];
-		}
-		catch (error) {
-			if (error instanceof Error) return [undefined, error];
-
-			const errObj = new Error(error?.toString
-				// eslint-disable-next-line @typescript-eslint/no-base-to-string
-				? `Stringified error to: ${error.toString()}`
-				: 'Could not stringify error',
-			{ cause: { value: error } });
-
-			return [undefined, errObj];
-		}
-	};
-}
-
-/**
- * The returned function from {@link trySync}.
- *
- * @typedef {(...args: Parameters<F>) => WrappedResult<ReturnType<F>>} WrappedFunction
- * @template {(...args: Parameters<F>) => ReturnType<F>} F
- */
-
-/**
- * Function-sugar/Syntax-sugar for handling functions that can throw errors. Wrapping then
- * into a try-catch block / "curried function" that returns a "tuple as array" of error and
- * value, which can be used for handling the error using a Go-like fashion. **This function
- * is for synchronous operations,** for asynchronous ones, see {@link tryAsync}.
- *
- * **If there's a error, the result is undefined**.
- * If there's not a error, error will be null and the result will be defined.
- *
- * @template {(...args: Parameters<F>) => ReturnType<F>} F
- * @param {F} func
- * - The function to be executed.
- * @returns {WrappedFunction<F>}
- * - The function to be immediately called with the wrapped function's arguments.
- * @example
- * const [error, json] = trySync(JSON.parse)('{ "hello": "world" }');
- * if (error !== null) {
- *   // error handling...
- *   console.log(error);
- * }
- * // continue the logic...
- */
-function trySync(func) {
-	/**
-	 * The returned function from {@link trySync}.
-	 *
-	 * @param {Parameters<F>} args
-	 * - The arguments of the wrapped function.
-	 * @returns {WrappedResult<ReturnType<F>>}
-	 * - The final tuple containing the Error object (if one occured) and the resulting value.
-	 */
-	return (...args) => {
-		try {
-			return [func(...args), null];
-		}
-		catch (error) {
-			if (error instanceof Error) return [undefined, error];
-
-			const errObj = new Error(error?.toString
-				// eslint-disable-next-line @typescript-eslint/no-base-to-string
-				? `Stringified error to: ${error.toString()}`
-				: 'Could not stringify error',
-			{ cause: { value: error } });
-
-			return [undefined, errObj];
-		}
-	};
-}
-
-export {
-	tryAsync as tryA,
-	tryAsync,
-	trySync as tryS,
-	trySync,
-};
-

test/placeholder.test.js

@@ -0,0 +1,7 @@
+// eslint-disable-next-line n/no-unpublished-import
+import { expect, test } from 'vitest';
+
+test('placeholder', () => {
+	expect(1).toBe(1);
+});
+

test/try.test.js

@@ -1,35 +0,0 @@
-/* eslint-disable import/no-relative-parent-imports */
-// eslint-disable-next-line n/no-unpublished-import
-import { describe, it } from 'vitest';
-
-import { tryA, tryS } from '../src/index.js';
-
-describe.concurrent('Return values', () => {
-	it('JSON parsing [Sync, Success]', ({ expect }) => {
-		const [json, error] = tryS(JSON.parse)('{ "hello": "world" }');
-
-		expect(error).toBe(null);
-		expect(json).toEqual({ hello: 'world' });
-	});
-	it('JSON parsing [Sync, Error]', ({ expect }) => {
-		const [json, error] = tryS(JSON.parse)('{ "hello: "world" }');
-
-		expect(error?.name).toEqual('SyntaxError');
-		expect(error).toBeInstanceOf(Error);
-		expect(json).toBe(undefined);
-	});
-	it('Fetch function [Async, Success]', async ({ expect }) => {
-		const [res, error] = await tryA(fetch)('https://example.com');
-
-		expect(error).toBe(null);
-		expect(res?.status).toBe(200);
-	});
-	it('Fetch function [Async, Error]', async ({ expect }) => {
-		const [res, error] = await tryA(fetch)('htps://example.com');
-
-		expect(error?.name).toEqual('TypeError');
-		expect(error).toBeInstanceOf(Error);
-		expect(res).toBe(undefined);
-	});
-});
-