jsfunx 1.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2025 Khiat Mohammed Abderrezzak
+
+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,256 @@
+# jsfunx
+
+[![npm version](https://img.shields.io/npm/v/jsfunx.svg)](https://www.npmjs.com/package/jsfunx)
+[![License](https://img.shields.io/npm/l/jsfunx.svg)](https://opensource.org/licenses/MIT)
+[![Downloads](https://img.shields.io/npm/dt/jsfunx.svg)](https://www.npmjs.com/package/jsfunx)
+
+The main reason why this library was created is to:
+
+### use
+
+```js
+import { isType, number } from "jsfunx"; // ESM
+
+// or
+
+// const { isType, number } = require("jsfunx"); // CJS
+
+/**
+ * Adds two numbers together and returns the result.
+ *
+ * @param {number} num1 - The first number.
+ * @param {number} num2 - The second number.
+ * @returns {number} The sum of `num1` and `num2`.
+ */
+
+function add(num1, num2) {
+  // 35 char
+
+  if (isType([num1, num2], number)) {
+    return num1 + num2;
+  }
+
+  throw TypeError("invalid arguments");
+}
+
+console.log(add(1, 3));
+
+// or
+
+console.log(add(Number(1), Number(3)));
+```
+
+### in place of
+
+```js
+/**
+ * Adds two numbers together and returns the result.
+ *
+ * @param {number} num1 - The first number.
+ * @param {number} num2 - The second number.
+ * @returns {number} The sum of `num1` and `num2`.
+ */
+
+function add(num1, num2) {
+  // 59 char
+
+  if (typeof num1 === "number" && typeof num2 === "number") {
+    return num1 + num2;
+  }
+
+  throw new TypeError("invalid arguments");
+}
+
+console.log(add(1, 3));
+
+// or
+
+console.log(add(Number(1), Number(3)));
+```
+
+### and
+
+```js
+import { isType, number, string } from "jsfunx"; // ESM
+
+// or
+
+// const { isType, number, string } = require("jsfunx"); // CJS
+
+/**
+ * Prints a message with the given name and age.
+ *
+ * @param {string} name - The person's name.
+ * @param {number} age - The person's age.
+ * @returns {void} This function does not return a value.
+ */
+
+function fun(name, age) {
+  // 44 char
+
+  if (isType([name, age], [string, number])) {
+    console.log(`your name is ${name} and your age is ${age}`);
+    return;
+  }
+
+  throw new TypeError("invalid arguments");
+}
+
+fun("mohamed", 23);
+
+// or
+
+fun(String("mohamed"), Number(23));
+```
+
+### in place of
+
+```js
+/**
+ * Prints a message with the given name and age.
+ *
+ * @param {string} name - The person's name.
+ * @param {number} age - The person's age.
+ * @returns {void} This function does not return a value.
+ */
+
+function fun(name, age) {
+  // 58 char
+
+  if (typeof name === "string" && typeof age === "number") {
+    console.log(`your name is ${name} and your age is ${age}`);
+    return;
+  }
+
+  throw new TypeError("invalid arguments");
+}
+
+fun("mohamed", 23);
+
+// or
+
+fun(String("mohamed"), Number(23));
+```
+
+### and
+
+```js
+import { instancesof } from "jsfunx"; // ESM
+
+// or
+
+// const { instancesof } = require("jsfunx"); // CJS
+
+/**
+ * Adds two numbers together and returns the result.
+ *
+ * @param {number} num1 - The first number.
+ * @param {number} num2 - The second number.
+ * @returns {number} The sum of `num1` and `num2`.
+ */
+
+function add(num1, num2) {
+  // 40 char
+
+  if (instancesof([num1, num2], Number)) {
+    return num1 + num2;
+  }
+
+  throw TypeError("invalid arguments");
+}
+
+console.log(add(new Number(1), new Number(3)));
+```
+
+### in place of
+
+```js
+/**
+ * Adds two numbers together and returns the result.
+ *
+ * @param {number} num1 - The first number.
+ * @param {number} num2 - The second number.
+ * @returns {number} The sum of `num1` and `num2`.
+ */
+
+function add(num1, num2) {
+  // 55 char
+
+  if (num1 instanceof Number && num2 instanceof Number) {
+    return num1 + num2;
+  }
+
+  throw new TypeError("invalid arguments");
+}
+
+console.log(add(new Number(1), new Number(3)));
+```
+
+### and
+
+```js
+import { instancesof } from "jsfunx"; // ESM
+
+// or
+
+// const { instancesof } = require("jsfunx"); // CJS
+
+/**
+ * Prints a message with the given name and age.
+ *
+ * @param {string} name - The person's name.
+ * @param {number} age - The person's age.
+ * @returns {void} This function does not return a value.
+ */
+
+function fun(name, age) {
+  // 49 char
+
+  if (instancesof([name, age], [String, Number])) {
+    console.log(`your name is ${name} and your age is ${age}`);
+    return;
+  }
+  throw new TypeError("invalid arguments");
+}
+
+fun(new String("mohamed"), new Number(23));
+```
+
+### in place of
+
+```js
+/**
+ * Prints a message with the given name and age.
+ *
+ * @param {string} name - The person's name.
+ * @param {number} age - The person's age.
+ * @returns {void} This function does not return a value.
+ */
+
+function fun(name, age) {
+  // 54 char
+
+  if (name instanceof String && age instanceof Number) {
+    console.log(`your name is ${name} and your age is ${age}`);
+    return;
+  }
+
+  throw new TypeError("invalid arguments");
+}
+
+fun(new String("mohamed"), new Number(23));
+```
+
+but not just this there is other funcs you can see the source code and check all the tests in the main fun.
+
+## Installation
+
+You can install `jsfunx` via npm:
+
+```bash
+npm install jsfunx
+```
+
+## License
+
+This project is licensed under the MIT LICENSE - see the [LICENSE](https://opensource.org/licenses/MIT) for more details.