@newdash/newdash/floor.js

javascript/typescript utility library

"use strict";
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.floor = void 0;
const createRound_1 = __importDefault(require("./.internal/createRound"));
/**
 * @internal
 * @private
 * @ignore
 */
const internal = (0, createRound_1.default)("floor");
/**
 * Computes `number` rounded down to `precision`.
 *
 * @since 5.7.0
 * @category Math
 * @param num The number to round down.
 * @param precision The precision to round down to.
 * @returns Returns the rounded down number.
 * @example
 *
 * ```js
 * floor(4.006)
 * // => 4
 *
 * floor(0.046, 2)
 * // => 0.04
 *
 * floor(4060, -2)
 * // => 4000
 * ```
 */
function floor(num, precision = 0) {
    return internal(num, precision);
}
exports.floor = floor;
exports.default = floor;