rich-domain/utils/ensure-number.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.EnsureNumber = void 0;
const is_nan_util_1 = require("./is-nan.util");
/**
 * @description Ensures the input is a valid number. If the input is `NaN` or `Infinity`, it returns `0`.
 *
 * @param value The number to validate.
 *
 * @returns The original number if it is valid, or `0` if the input is `NaN` or `Infinity`.
 *
 * @example
 * ```typescript
 * EnsureNumber(42); // Returns 42
 * EnsureNumber(NaN); // Returns 0
 * EnsureNumber(Infinity); // Returns 0
 * ```
 */
const EnsureNumber = (value) => {
    if ((0, is_nan_util_1.default)(value) || value === Infinity)
        return 0;
    return value;
};
exports.EnsureNumber = EnsureNumber;
exports.default = exports.EnsureNumber;
//# sourceMappingURL=ensure-number.js.map