rich-domain/utils/divide-number.util.js

This package provide utils file and interfaces to assistant build a complex application with domain driving design

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.Divide = void 0;
const ensure_number_1 = require("./ensure-number");
const is_nan_util_1 = require("./is-nan.util");
const normalize_number_util_1 = require("./normalize-number.util");
const to_long_number_util_1 = require("./to-long-number.util");
const to_precision_util_1 = require("./to-precision.util");
/**
 * @description Divides two numbers (`valueA` by `valueB`) with support for validation and normalization.
 * Handles edge cases such as non-numeric inputs and applies a specified precision to the result.
 *
 * @param valueA The dividend (numerator). Can be a number or a value convertible to a number.
 * @param valueB The divisor (denominator). Can be a number or a value convertible to a number.
 * @param precision The number of decimal places to apply to the result. Defaults to 5.
 *
 * @returns The result of the division, normalized and adjusted to the specified precision.
 * Returns `0` if either value is not a valid number.
 *
 * @example
 * ```typescript
 * Divide(10, 2); // Returns 5
 * Divide(10, 3, 3); // Returns 3.333
 * Divide("10", "2"); // Returns 5 (handles string inputs)
 * Divide(NaN, 2); // Returns 0
 * ```
 */
const Divide = (valueA, valueB, precision = 5) => {
    const isValueOneNumber = typeof valueA === 'number';
    const isValueTwoNumber = typeof valueB === 'number';
    const isBothNumber = isValueOneNumber && isValueTwoNumber;
    if (!isBothNumber) {
        const isNaNValueA = (0, is_nan_util_1.default)(valueA);
        const isNaNValueB = (0, is_nan_util_1.default)(valueB);
        const isBothNaN = isNaNValueA && isNaNValueB;
        if (isBothNaN || isNaNValueA || isNaNValueB)
            return 0;
        const result = (0, to_precision_util_1.default)((0, normalize_number_util_1.default)(((0, to_long_number_util_1.default)((0, normalize_number_util_1.default)(valueA)) / (0, to_long_number_util_1.default)((0, normalize_number_util_1.default)(valueB)))), precision);
        return (0, ensure_number_1.default)(result);
    }
    const result = (0, to_precision_util_1.default)((0, normalize_number_util_1.default)(((0, to_long_number_util_1.default)(valueA) / (0, to_long_number_util_1.default)(valueB))), precision);
    return (0, ensure_number_1.default)(result);
};
exports.Divide = Divide;
exports.default = exports.Divide;
//# sourceMappingURL=divide-number.util.js.map