tiny-essentials
Version:
Collection of small, essential scripts designed to be used across various projects. These simple utilities are crafted for speed, ease of use, and versatility.
60 lines (56 loc) • 1.76 kB
JavaScript
;
/**
* Rule of Three utility.
* Performs direct or inverse proportional calculation.
*/
const ruleOfThree = {
/**
* Returns the client-side version of the `execute` function as a string.
* Useful for embedding logic in the frontend.
*
* @returns {string} Function as string.
*/
getClient: function () {
return ruleOfThree.execute.toString();
},
/**
* Executes a Rule of Three calculation.
*
* @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).
* @returns {number} The result of the Rule of Three operation.
* @deprecated
*
* Rule of Three Formula (Direct Proportion):
* val1 / val2 = val3 / result
*
* For Inverse Proportion:
* val1 / val3 = val2 / result
*
* Visual Representation:
*
* For Direct Proportion:
* val1 val2
* ----- = ------
* val3 result
*
* For Inverse Proportion:
* val1 val2
* ----- = ------
* val3 result
*
* @example
* // Direct proportion:
* ruleOfThree.execute(2, 6, 3, false); // → 9
*
* @example
* // Inverse proportion:
* ruleOfThree.execute(2, 6, 3, true); // → 4
*/
execute: function (val1, val2, val3, inverse) {
return inverse ? Number(val1 * val2) / val3 : Number(val3 * val2) / val1;
},
};
module.exports = ruleOfThree;