tiny-essentials 1.3.1 → 1.4.0

package/dist/v1/basics/simpleMath.cjs

@@ -6,7 +6,7 @@
  * @param {number} val1 - The first reference value (numerator in direct proportion, denominator in inverse).
  * @param {number} val2 - The second reference value (denominator in direct proportion, numerator in inverse).
  * @param {number} val3 - The third value (numerator in direct proportion, denominator in inverse).
- * @param {boolean} inverse - Whether the calculation should use inverse proportion (true for inverse, false for direct).
+ * @param {boolean} [inverse] - Whether the calculation should use inverse proportion (true for inverse, false for direct).
  * @returns {number} The result of the Rule of Three operation.
  *
  * Rule of Three Formula (Direct Proportion):
@@ -35,7 +35,7 @@
  * // Inverse proportion:
  * ruleOfThree.execute(2, 6, 3, true); // → 4
  */
-function ruleOfThree(val1, val2, val3, inverse) {
+function ruleOfThree(val1, val2, val3, inverse = false) {
   return inverse ? Number(val1 * val2) / val3 : Number(val3 * val2) / val1;
 }
 

package/dist/v1/basics/simpleMath.d.mts

@@ -4,7 +4,7 @@
  * @param {number} val1 - The first reference value (numerator in direct proportion, denominator in inverse).
  * @param {number} val2 - The second reference value (denominator in direct proportion, numerator in inverse).
  * @param {number} val3 - The third value (numerator in direct proportion, denominator in inverse).
- * @param {boolean} inverse - Whether the calculation should use inverse proportion (true for inverse, false for direct).
+ * @param {boolean} [inverse] - Whether the calculation should use inverse proportion (true for inverse, false for direct).
  * @returns {number} The result of the Rule of Three operation.
  *
  * Rule of Three Formula (Direct Proportion):
@@ -33,7 +33,7 @@
  * // Inverse proportion:
  * ruleOfThree.execute(2, 6, 3, true); // → 4
  */
-export function ruleOfThree(val1: number, val2: number, val3: number, inverse: boolean): number;
+export function ruleOfThree(val1: number, val2: number, val3: number, inverse?: boolean): number;
 /**
  * Calculates a percentage of a given base value.
  * @param {number} price - The base value.

package/dist/v1/basics/simpleMath.mjs

@@ -4,7 +4,7 @@
  * @param {number} val1 - The first reference value (numerator in direct proportion, denominator in inverse).
  * @param {number} val2 - The second reference value (denominator in direct proportion, numerator in inverse).
  * @param {number} val3 - The third value (numerator in direct proportion, denominator in inverse).
- * @param {boolean} inverse - Whether the calculation should use inverse proportion (true for inverse, false for direct).
+ * @param {boolean} [inverse] - Whether the calculation should use inverse proportion (true for inverse, false for direct).
  * @returns {number} The result of the Rule of Three operation.
  *
  * Rule of Three Formula (Direct Proportion):
@@ -33,7 +33,7 @@
  * // Inverse proportion:
  * ruleOfThree.execute(2, 6, 3, true); // → 4
  */
-export function ruleOfThree(val1, val2, val3, inverse) {
+export function ruleOfThree(val1, val2, val3, inverse = false) {
     return inverse ? Number(val1 * val2) / val3 : Number(val3 * val2) / val1;
 }
 /**

package/dist/v1/index.cjs

@@ -17,6 +17,7 @@ exports.formatCustomTimer = clock.formatCustomTimer;
 exports.formatDayTimer = clock.formatDayTimer;
 exports.formatTimer = clock.formatTimer;
 exports.getTimeDuration = clock.getTimeDuration;
+exports.checkObj = objFilter.checkObj;
 exports.cloneObjTypeOrder = objFilter.cloneObjTypeOrder;
 exports.countObj = objFilter.countObj;
 exports.extendObjType = objFilter.extendObjType;

package/dist/v1/index.d.mts

@@ -3,6 +3,7 @@ import { extendObjType } from './basics/objFilter.mjs';
 import { reorderObjTypeOrder } from './basics/objFilter.mjs';
 import { cloneObjTypeOrder } from './basics/objFilter.mjs';
 import { countObj } from './basics/objFilter.mjs';
+import { checkObj } from './basics/objFilter.mjs';
 import { objType } from './basics/objFilter.mjs';
 import { ruleOfThree } from './basics/simpleMath.mjs';
 import { getSimplePerc } from './basics/simpleMath.mjs';
@@ -15,4 +16,4 @@ import { getTimeDuration } from './basics/clock.mjs';
 import { shuffleArray } from './basics/array.mjs';
 import { toTitleCase } from './basics/text.mjs';
 import { toTitleCaseLowerFirst } from './basics/text.mjs';
-export { TinyLevelUp, extendObjType, reorderObjTypeOrder, cloneObjTypeOrder, countObj, objType, ruleOfThree, getSimplePerc, asyncReplace, getAge, formatCustomTimer, formatDayTimer, formatTimer, getTimeDuration, shuffleArray, toTitleCase, toTitleCaseLowerFirst };
+export { TinyLevelUp, extendObjType, reorderObjTypeOrder, cloneObjTypeOrder, countObj, checkObj, objType, ruleOfThree, getSimplePerc, asyncReplace, getAge, formatCustomTimer, formatDayTimer, formatTimer, getTimeDuration, shuffleArray, toTitleCase, toTitleCaseLowerFirst };

package/dist/v1/index.mjs

@@ -2,7 +2,7 @@ import asyncReplace from '../legacy/libs/replaceAsync.mjs';
 import TinyLevelUp from '../legacy/libs/userLevel.mjs';
 import { shuffleArray } from './basics/array.mjs';
 import { formatCustomTimer, formatDayTimer, formatTimer, getTimeDuration, } from './basics/clock.mjs';
-import { countObj, extendObjType, reorderObjTypeOrder, cloneObjTypeOrder, objType, } from './basics/objFilter.mjs';
+import { countObj, extendObjType, reorderObjTypeOrder, cloneObjTypeOrder, objType, checkObj, } from './basics/objFilter.mjs';
 import { getAge, getSimplePerc, ruleOfThree } from './basics/simpleMath.mjs';
 import { toTitleCase, toTitleCaseLowerFirst } from './basics/text.mjs';
-export { TinyLevelUp, extendObjType, reorderObjTypeOrder, cloneObjTypeOrder, countObj, objType, ruleOfThree, getSimplePerc, asyncReplace, getAge, formatCustomTimer, formatDayTimer, formatTimer, getTimeDuration, shuffleArray, toTitleCase, toTitleCaseLowerFirst, };
+export { TinyLevelUp, extendObjType, reorderObjTypeOrder, cloneObjTypeOrder, countObj, checkObj, objType, ruleOfThree, getSimplePerc, asyncReplace, getAge, formatCustomTimer, formatDayTimer, formatTimer, getTimeDuration, shuffleArray, toTitleCase, toTitleCaseLowerFirst, };

package/docs/basics/objFilter.md

@@ -40,6 +40,39 @@ Returns:
 
 ---
 
+### 🔍 `checkObj(obj)`
+
+Checks the type of a given object and returns the validation result if a known type is detected.
+
+```js
+checkObj('hello');
+// { valid: true, type: "string" }
+
+checkObj(123);
+// { valid: true, type: "number" }
+
+checkObj(undefined);
+// { valid: true, type: "undefined" }
+
+checkObj(Symbol('sym'));
+// { valid: true, type: "symbol" }
+
+checkObj(() => {});
+// { valid: true, type: "function" }
+
+checkObj(null);
+// { valid: true, type: "null" }
+
+checkObj(Object.create(null));
+// { valid: true, type: "object" }
+```
+
+Returns:
+- `{ valid: true, type: "<type>" }` if the type is recognized
+- `{ valid: null, type: null }` if no matching type is found
+
+---
+
 ### ➕ `extendObjType(newTypes, [index])`
 
 Add your own custom types. You can optionally define where in the check order they go.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tiny-essentials",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "Collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.",
   "scripts": {
     "test": "npm run test:mjs && npm run test:cjs && npm run test:js",