@technobuddha/library
Version:
A large library of useful functions
29 lines • 1.48 kB
JavaScript
import { empty, space } from "../unicode.js";
import { numbering } from "./numbering.js";
/**
* Get a short description of a number
*
* @remarks this is a shortcut to calling cardinal with options \{groups: 1, digits: true\}
*
* @example 1000000 "1 million"
* @example 101323847382459 "101 trillion"
*
* @param input - number to convert
* @returns number as text
*
* @group Math
* @category Numbers
*/
export function summarize(input) {
return numbering(input, {
output: { integer: 'hybrid', fraction: 'alphabetic' },
and: empty,
hyphen: space,
tolerance: 0.01,
denominators: 'common',
precision: 3,
ordinal: false,
shift: 'decimal',
});
}
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic3VtbWFyaXplLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL251bWJlcmluZy9zdW1tYXJpemUudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBQUEsT0FBTyxFQUFFLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxlQUFlLENBQUM7QUFFN0MsT0FBTyxFQUFFLFNBQVMsRUFBRSxNQUFNLGdCQUFnQixDQUFDO0FBRTNDOzs7Ozs7Ozs7Ozs7O0dBYUc7QUFDSCxNQUFNLFVBQVUsU0FBUyxDQUFDLEtBQWE7SUFDckMsT0FBTyxTQUFTLENBQUMsS0FBSyxFQUFFO1FBQ3RCLE1BQU0sRUFBRSxFQUFFLE9BQU8sRUFBRSxRQUFRLEVBQUUsUUFBUSxFQUFFLFlBQVksRUFBRTtRQUNyRCxHQUFHLEVBQUUsS0FBSztRQUNWLE1BQU0sRUFBRSxLQUFLO1FBQ2IsU0FBUyxFQUFFLElBQUk7UUFDZixZQUFZLEVBQUUsUUFBUTtRQUN0QixTQUFTLEVBQUUsQ0FBQztRQUNaLE9BQU8sRUFBRSxLQUFLO1FBQ2QsS0FBSyxFQUFFLFNBQVM7S0FDakIsQ0FBQyxDQUFDO0FBQ0wsQ0FBQyJ9