pretty-num/types/to-precision.d.ts

Lightweight module for formatting numbers to a human readable string

/**
 * Reduce precision, accept precision settings:
 * - 'reduce', 'default' - reduce precision to specified number of decimal digits, strip unnecessary ending zeros.
 * - 'reduceSignificant', 'significant' - reduce precision to specified number of significant decimal digits, strip unnecessary ending zeros.
 * - 'fixed' - reduce precision to specified number of decimal digits, pad with ending zeros.
 * - 'increase' - pad with ending zeros to increase precision to specified number of decimal digits.
 * Don't work with exponential notation, use `from-exponential` if necessary
 * @param {string|number} num
 * @param {number} [precision]
 * @param {object} [options]
 * @param {PRECISION_SETTING} [options.precisionSetting = PRECISION_SETTING.REDUCE]
 * @param {ROUNDING_MODE} [options.roundingMode = ROUNDING_MODE.HALF_EVEN]
 * @return {string}
 */
export default function toPrecision(num: string | number, precision?: number, options?: {
    precisionSetting?: PRECISION_SETTING;
    roundingMode?: ROUNDING_MODE;
}): string;
/**
 * Reduce precision with `reduce` or `reduceSignificant` precisionSetting, can produce ending dot or zeros
 * @param {string} numString
 * @param {number} precision
 * @param {object} [options]
 * @param {PRECISION_SETTING} [options.precisionSetting = PRECISION_SETTING.REDUCE]
 * @param {ROUNDING_MODE} [options.roundingMode]
 * @return {string}
 */
export function _reducePrecision(numString: string, precision: number, { precisionSetting, roundingMode }?: {
    precisionSetting?: PRECISION_SETTING;
    roundingMode?: ROUNDING_MODE;
}): string;
export type PRECISION_SETTING = number;
export namespace PRECISION_SETTING {
    let REDUCE: number;
    let REDUCE_SIGNIFICANT: number;
    let FIXED: number;
    let INCREASE: number;
}
export type ROUNDING_MODE = number;
export namespace ROUNDING_MODE {
    let UP: number;
    let DOWN: number;
    let CEIL: number;
    let FLOOR: number;
    let HALF_UP: number;
    let HALF_DOWN: number;
    let HALF_EVEN: number;
}
//# sourceMappingURL=to-precision.d.ts.map