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

Lightweight module for formatting numbers to a human readable string

/**
 * @import {PRECISION_SETTING} from './to-precision.js';
 * @import {ROUNDING_MODE} from './to-precision.js';
 */
/**
 * @param {number|string} value
 * @param {object} [options]
 * @param {number} [options.precision]
 * @param {PRECISION_SETTING} [options.precisionSetting = PRECISION_SETTING.REDUCE]
 * @param {ROUNDING_MODE} [options.roundingMode = ROUNDING_MODE.HALF_EVEN]
 * @param {string} [options.thousandsSeparator]
 * @param {string} [options.decimalSeparator = '.']
 * @param {boolean} [options.separateOneDigit = true]
 * @return {string}
 */
export default function prettyNum(value: number | string, { precision, precisionSetting, roundingMode, thousandsSeparator, decimalSeparator, separateOneDigit }?: {
    precision?: number;
    precisionSetting?: PRECISION_SETTING;
    roundingMode?: ROUNDING_MODE;
    thousandsSeparator?: string;
    decimalSeparator?: string;
    separateOneDigit?: boolean;
}): string;
import type { PRECISION_SETTING } from './to-precision.js';
import type { ROUNDING_MODE } from './to-precision.js';
//# sourceMappingURL=pretty-num.d.ts.map