@energi/utils v0.3.1

energi-utils

Javascript utilities for web development

Available Methods:

amountToWei

Description: Convert number digit to wei Value

Usage

amountToWei(<amount as string>, <decimal>)

Example

amountToWei('1.01', 18);

copyToClipboard

Description: With this method, you can easily implement a copy to clip board feature

Usage

const result = copyToClipboard(<text>)

Response: Returns either a true/false depending on the status of the operation

Example

const result = copyToClipboard('Some text!');
if (result) {
  console.log('Copied to clipboard');
} else {
  throw new Error('Error: could not copy to clipboard');
}

detectMobile

Description: Detect if user is on a mobile device

Example

import { isMobile } from '@energi/utils';
if (isMobile) {
  console.log('You are using a mobile device');
}

formatBN

Description: Module formats energi bignumber amounts (wei) into NRG amount, with decimal and thousands separator, internationalized

Usage

formatBN(toBN(bnStringRoundUp), {
  locale,
  decimals: 18, // force the format to have specific number of decimals
  assetDigits: 18,
});

Example

import { formatBN } from '@energi/utils';
const locale = 'en-US';
formatBN(toBN(bnStringRoundUp), {
  locale,
  decimals: 2,
  assetDigits: 18,
});