polkadot-js/common

View on GitHub
packages/util/src/format/si.ts

Summary

Maintainability
A
0 mins
Test Coverage
// Copyright 2017-2024 @polkadot/util authors & contributors
// SPDX-License-Identifier: Apache-2.0

import type { SiDef } from '../types.js';

/** @internal */
export const SI_MID = 8;

/** @internal */
export const SI: SiDef[] = [
  { power: -24, text: 'yocto', value: 'y' },
  { power: -21, text: 'zepto', value: 'z' },
  { power: -18, text: 'atto', value: 'a' },
  { power: -15, text: 'femto', value: 'f' },
  { power: -12, text: 'pico', value: 'p' },
  { power: -9, text: 'nano', value: 'n' },
  { power: -6, text: 'micro', value: 'ยต' },
  { power: -3, text: 'milli', value: 'm' },
  { power: 0, text: 'Unit', value: '-' }, // position 8
  { power: 3, text: 'Kilo', value: 'k' },
  { power: 6, text: 'Mill', value: 'M' }, // Mega, M
  { power: 9, text: 'Bill', value: 'B' }, // Giga, G
  { power: 12, text: 'Tril', value: 'T' }, // Tera, T
  { power: 15, text: 'Peta', value: 'P' },
  { power: 18, text: 'Exa', value: 'E' },
  { power: 21, text: 'Zeta', value: 'Z' },
  { power: 24, text: 'Yotta', value: 'Y' }
];

// Given a SI type (e.g. k, m, Y) find the SI definition
/** @internal */
export function findSi (type: string): SiDef {
  // use a loop here, better RN support (which doesn't have [].find)
  for (let i = 0, count = SI.length; i < count; i++) {
    if (SI[i].value === type) {
      return SI[i];
    }
  }

  return SI[SI_MID];
}

/** @internal */
export function calcSi (text: string, decimals: number, forceUnit?: string): SiDef {
  if (forceUnit) {
    return findSi(forceUnit);
  }

  const siDefIndex = (SI_MID - 1) + Math.ceil((text.length - decimals) / 3);

  return SI[siDefIndex] || SI[siDefIndex < 0 ? 0 : SI.length - 1];
}