diff --git a/packages/ui-util/README.md b/packages/ui-util/README.md index d41025d5..e28680f2 100644 --- a/packages/ui-util/README.md +++ b/packages/ui-util/README.md @@ -14,3 +14,10 @@ formatBalance.setDefaults({ formatBalance('12345'); // 12.345z DOT ``` + +## calcSi + +```js +// calculates the SI unit applucable +formatBalance.calcSi('12345'); // { power: 3, value: 'k', text: 'Kilo' } +``` diff --git a/packages/ui-util/src/formatBalance.ts b/packages/ui-util/src/formatBalance.ts index bf7a9bbe..0db9b88e 100644 --- a/packages/ui-util/src/formatBalance.ts +++ b/packages/ui-util/src/formatBalance.ts @@ -15,7 +15,7 @@ type Defaults = { interface BalanceFormatter { (input?: number | string | BN, withSi?: boolean, decimals?: number): string; - calcSi (text: string, decimals: number): SiDef; + calcSi (text: string, decimals?: number): SiDef; findSi (type: string): SiDef; getDefaults (): Defaults; getOptions (decimals?: number): Array; @@ -56,7 +56,8 @@ function _formatBalance (input?: number | string | BN, withSi: boolean = true, d const formatBalance = _formatBalance as BalanceFormatter; -formatBalance.calcSi = calcSi; +formatBalance.calcSi = (text: string, decimals: number = defaultDecimals): SiDef => + calcSi(text, decimals); formatBalance.findSi = findSi; formatBalance.getDefaults = (): Defaults => {