@toreda/strong-types/dist/to/float.js

Better TypeScript code in fewer lines.

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.toFloat = void 0;
const big_js_1 = __importDefault(require("big.js"));
/**
 *	MIT License
 *
 *	Copyright (c) 2019 - 2021 Toreda, Inc.
 *
 *	Permission is hereby granted, free of charge, to any person obtaining a copy
 *	of this software and associated documentation files (the "Software"), to deal
 *	in the Software without restriction, including without limitation the rights
 *	to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 *	copies of the Software, and to permit persons to whom the Software is
 *	furnished to do so, subject to the following conditions:

 * 	The above copyright notice and this permission notice shall be included in all
 * 	copies or substantial portions of the Software.
 *
 * 	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 *	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 *	FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * 	AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 *	LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 *	OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * 	SOFTWARE.
 *
 */
const match_1 = require("../type/match");
/**
 * Convert a Big, string, or number to standard float (`number`). Returns `null` when
 * input value is `undefined`, `null`, or a `Big` value which cannot be safely converted
 * to `number`. Useful for working with `Big` values but small types, such as a small exponent,
 * which must be in number form to use with a `Big`.
 * @param value
 * @returns
 *
 * @category Strong Helpers
 */
function toFloat(value) {
    if (value === undefined || value === null) {
        return null;
    }
    if ((0, match_1.typeMatch)(value, big_js_1.default)) {
        if (value.gt(Number.MAX_SAFE_INTEGER) || value.lt(Number.MIN_SAFE_INTEGER)) {
            return null;
        }
        else {
            return value.toNumber();
        }
    }
    if (typeof value === 'string') {
        const result = parseFloat(value);
        if (!isNaN(result) && isFinite(result)) {
            return result;
        }
        else {
            return null;
        }
    }
    return value;
}
exports.toFloat = toFloat;