jsfunx 1.1.0 → 1.1.2

package/README.md

@@ -13,6 +13,8 @@ import { isType, number } from "jsfunx"; // ESM
 
 // or
 
+// "use strict"; // CJS
+
 // const { isType, number } = require("jsfunx"); // CJS
 
 /**
@@ -21,6 +23,7 @@ import { isType, number } from "jsfunx"; // ESM
  * @param {number} num1 - The first number.
  * @param {number} num2 - The second number.
  * @returns {number} The sum of `num1` and `num2`.
+ * @throws {TypeError} If one or both arguments are not numbers.
  */
 
 function add(num1, num2) {
@@ -43,12 +46,15 @@ console.log(add(Number(1), Number(3)));
 ### in place of
 
 ```js
+// "use strict"; // 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`.
+ * @throws {TypeError} If one or both arguments are not numbers.
  */
 
 function add(num1, num2) {
@@ -75,6 +81,8 @@ import { isType, number, string } from "jsfunx"; // ESM
 
 // or
 
+// "use strict"; // CJS
+
 // const { isType, number, string } = require("jsfunx"); // CJS
 
 /**
@@ -83,6 +91,7 @@ import { isType, number, string } from "jsfunx"; // ESM
  * @param {string} name - The person's name.
  * @param {number} age - The person's age.
  * @returns {void} This function does not return a value.
+ * @throws {TypeError} If `name` is not a string or `age` is not a number.
  */
 
 function fun(name, age) {
@@ -106,12 +115,15 @@ fun(String("mohamed"), Number(23));
 ### in place of
 
 ```js
+// "use strict"; // 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.
+ * @throws {TypeError} If `name` is not a string or `age` is not a number.
  */
 
 function fun(name, age) {
@@ -139,21 +151,24 @@ import { instancesof } from "jsfunx"; // ESM
 
 // or
 
+// "use strict"; // CJS
+
 // 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`.
+ * @param {Number} num1 - The first number.
+ * @param {Number} num2 - The second number.
+ * @returns {Number} The sum of `num1` and `num2`.
+ * @throws {TypeError} If one or both arguments are not numbers objects.
  */
 
 function add(num1, num2) {
   // 40 char
 
   if (instancesof([num1, num2], Number)) {
-    return num1 + num2;
+    return new Number(num1 + num2);
   }
 
   throw new TypeError("invalid arguments types");
@@ -165,19 +180,22 @@ console.log(add(new Number(1), new Number(3)));
 ### in place of
 
 ```js
+// "use strict"; // 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`.
+ * @param {Number} num1 - The first number.
+ * @param {Number} num2 - The second number.
+ * @returns {Number} The sum of `num1` and `num2`.
+ * @throws {TypeError} If one or both arguments are not numbers objects.
  */
 
 function add(num1, num2) {
   // 55 char
 
   if (num1 instanceof Number && num2 instanceof Number) {
-    return num1 + num2;
+    return new Number(num1 + num2);
   }
 
   throw new TypeError("invalid arguments types");
@@ -193,14 +211,17 @@ import { instancesof } from "jsfunx"; // ESM
 
 // or
 
+// "use strict"; // CJS
+
 // 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.
+ * @param {String} name - The person's name.
+ * @param {Number} age - The person's age.
  * @returns {void} This function does not return a value.
+ * @throws {TypeError} If `name` is not a string object or `age` is not a number object.
  */
 
 function fun(name, age) {
@@ -220,12 +241,15 @@ fun(new String("mohamed"), new Number(23));
 ### in place of
 
 ```js
+// "use strict"; // CJS
+
 /**
  * Prints a message with the given name and age.
  *
- * @param {string} name - The person's name.
- * @param {number} age - The person's age.
+ * @param {String} name - The person's name.
+ * @param {Number} age - The person's age.
  * @returns {void} This function does not return a value.
+ * @throws {TypeError} If `name` is not a string object or `age` is not a number object.
  */
 
 function fun(name, age) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jsfunx",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "JavaScript utility functions for cleaner, more readable code",
   "main": "./jsfunx.cjs",
   "module": "./jsfunx.mjs",