numbers.ts 2.0 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071
  1. import type { ValueOf } from '../../types/util';
  2. export const DECIMAL_UNITS = Object.freeze({
  3. ONE: 1,
  4. TEN: 10,
  5. HUNDRED: 100,
  6. THOUSAND: 1_000,
  7. MILLION: 1_000_000,
  8. BILLION: 1_000_000_000,
  9. TRILLION: 1_000_000_000_000,
  10. });
  11. export type DecimalUnits = ValueOf<typeof DECIMAL_UNITS>;
  12. const TEN_THOUSAND = DECIMAL_UNITS.THOUSAND * 10;
  13. const TEN_MILLIONS = DECIMAL_UNITS.MILLION * 10;
  14. export type ShortNumber = [number, DecimalUnits, 0 | 1]; // Array of: shorten number, unit of shorten number and maximum fraction digits
  15. /**
  16. * @param sourceNumber Number to convert to short number
  17. * @returns Calculated short number
  18. * @example
  19. * shortNumber(5936);
  20. * // => [5.936, 1000, 1]
  21. */
  22. export function toShortNumber(sourceNumber: number): ShortNumber {
  23. if (sourceNumber < DECIMAL_UNITS.THOUSAND) {
  24. return [sourceNumber, DECIMAL_UNITS.ONE, 0];
  25. } else if (sourceNumber < DECIMAL_UNITS.MILLION) {
  26. return [
  27. sourceNumber / DECIMAL_UNITS.THOUSAND,
  28. DECIMAL_UNITS.THOUSAND,
  29. sourceNumber < TEN_THOUSAND ? 1 : 0,
  30. ];
  31. } else if (sourceNumber < DECIMAL_UNITS.BILLION) {
  32. return [
  33. sourceNumber / DECIMAL_UNITS.MILLION,
  34. DECIMAL_UNITS.MILLION,
  35. sourceNumber < TEN_MILLIONS ? 1 : 0,
  36. ];
  37. } else if (sourceNumber < DECIMAL_UNITS.TRILLION) {
  38. return [sourceNumber / DECIMAL_UNITS.BILLION, DECIMAL_UNITS.BILLION, 0];
  39. }
  40. return [sourceNumber, DECIMAL_UNITS.ONE, 0];
  41. }
  42. /**
  43. * @param sourceNumber Original number that is shortened
  44. * @param division The scale in which short number is displayed
  45. * @returns Number that can be used for plurals when short form used
  46. * @example
  47. * pluralReady(1793, DECIMAL_UNITS.THOUSAND)
  48. * // => 1790
  49. */
  50. export function pluralReady(
  51. sourceNumber: number,
  52. division: DecimalUnits | null,
  53. ): number {
  54. if (division == null || division < DECIMAL_UNITS.HUNDRED) {
  55. return sourceNumber;
  56. }
  57. const closestScale = division / DECIMAL_UNITS.TEN;
  58. return Math.trunc(sourceNumber / closestScale) * closestScale;
  59. }
  60. export function roundTo10(num: number): number {
  61. return Math.round(num * 0.1) / 0.1;
  62. }