|
| 1 | +import {formatNumber, roundToPrecision} from '../dataFormatters/dataFormatters'; |
| 2 | +import {UNBREAKABLE_GAP, isNumeric} from '../utils'; |
| 3 | + |
| 4 | +import type {FormatToSizeArgs, FormatValuesArgs} from './common'; |
| 5 | +import i18n from './i18n'; |
| 6 | + |
| 7 | +const sizes = { |
| 8 | + thousand: { |
| 9 | + value: 1_000, |
| 10 | + label: i18n('label_thousand'), |
| 11 | + }, |
| 12 | + million: { |
| 13 | + value: 1_000_000, |
| 14 | + label: i18n('label_million'), |
| 15 | + }, |
| 16 | + billion: { |
| 17 | + value: 1_000_000_000, |
| 18 | + label: i18n('label_billion'), |
| 19 | + }, |
| 20 | + trillion: { |
| 21 | + value: 1_000_000_000_000, |
| 22 | + label: i18n('label_trillion'), |
| 23 | + }, |
| 24 | +}; |
| 25 | + |
| 26 | +export type Digits = keyof typeof sizes; |
| 27 | + |
| 28 | +/** |
| 29 | + * This function is needed to keep more than 3 digits of the same size. |
| 30 | + * |
| 31 | + * @param significantDigits - number of digits above 3 |
| 32 | + * @returns size to format value to get required number of digits |
| 33 | + * |
| 34 | + * By default value converted to the next size when it's above 1000, |
| 35 | + * so we have 900mb and 1gb. To extend it additional significantDigits could be set |
| 36 | + * |
| 37 | + * significantDigits value added above default 3 |
| 38 | + * |
| 39 | + * significantDigits = 1 - 9 000k and 10m |
| 40 | + * |
| 41 | + * significantDigits = 2 - 90 000m and 100b |
| 42 | + * |
| 43 | + * significantDigits = 3 - 900 000b and 1000t |
| 44 | + */ |
| 45 | +export const getNumberWithSignificantDigits = (value: number, significantDigits: number) => { |
| 46 | + const multiplier = 10 ** significantDigits; |
| 47 | + |
| 48 | + const thousandLevel = sizes.million.value * multiplier; |
| 49 | + const millionLevel = sizes.million.value * multiplier; |
| 50 | + const billionLevel = sizes.billion.value * multiplier; |
| 51 | + const trillionLevel = sizes.trillion.value * multiplier; |
| 52 | + |
| 53 | + let size: Digits = 'thousand'; |
| 54 | + |
| 55 | + if (value > thousandLevel) { |
| 56 | + size = 'thousand'; |
| 57 | + } |
| 58 | + if (value >= millionLevel) { |
| 59 | + size = 'million'; |
| 60 | + } |
| 61 | + if (value >= billionLevel) { |
| 62 | + size = 'billion'; |
| 63 | + } |
| 64 | + if (value >= trillionLevel) { |
| 65 | + size = 'trillion'; |
| 66 | + } |
| 67 | + |
| 68 | + return size; |
| 69 | +}; |
| 70 | + |
| 71 | +const formatToSize = ({value, size = 'thousand', precision = 0}: FormatToSizeArgs<Digits>) => { |
| 72 | + const result = roundToPrecision(Number(value) / sizes[size].value, precision); |
| 73 | + |
| 74 | + return formatNumber(result); |
| 75 | +}; |
| 76 | + |
| 77 | +const addSizeLabel = (result: string, size: Digits, delimiter = UNBREAKABLE_GAP) => { |
| 78 | + return result + delimiter + sizes[size].label; |
| 79 | +}; |
| 80 | + |
| 81 | +/** |
| 82 | + * @param significantDigits - number of digits above 3 |
| 83 | + */ |
| 84 | +export const formatNumberWithDigits = ({ |
| 85 | + value, |
| 86 | + size, |
| 87 | + withSizeLabel = true, |
| 88 | + significantDigits = 0, |
| 89 | + delimiter, |
| 90 | + ...params |
| 91 | +}: FormatValuesArgs<Digits>) => { |
| 92 | + if (!isNumeric(value)) { |
| 93 | + return ''; |
| 94 | + } |
| 95 | + |
| 96 | + const numValue = Number(value); |
| 97 | + |
| 98 | + const sizeToConvert = size ?? getNumberWithSignificantDigits(numValue, significantDigits); |
| 99 | + |
| 100 | + const result = formatToSize({value: numValue, size: sizeToConvert, ...params}); |
| 101 | + |
| 102 | + if (withSizeLabel) { |
| 103 | + return addSizeLabel(result, sizeToConvert, delimiter); |
| 104 | + } |
| 105 | + |
| 106 | + return result; |
| 107 | +}; |
0 commit comments