@kikiutils/node/dist/number.cjs

A modular utility library for Node.js offering secure hashing, flexible logging, datetime manipulation, and more.

'use strict';

const millify = require('millify');

/**
 * Converts a large number into a compact, human-readable string using `millify`.
 *
 * Applies lowercase units (e.g. 'k', 'm') and default precision of 2, unless overridden.
 *
 * @param {number} value - The number to format.
 * @param {Parameters<typeof millify>[1]} [options] - Optional configuration passed to `millify`.
 * @returns {string} The compact number string.
 *
 * @example
 * ```typescript
 * import { toCompactNumberString } from '@kikiutils/node/number';
 *
 * console.log(toCompactNumberString(1234567)); // 1.23m
 * console.log(toCompactNumberString(1234567, { precision: 3 })); // 1.235m
 * ```
 */
function toCompactNumberString(value, options) {
    return millify.millify(value, {
        lowercase: true,
        precision: 2,
        ...options,
    });
}

exports.toCompactNumberString = toCompactNumberString;
//# sourceMappingURL=number.cjs.map