@yoroi/common/lib/typescript/numbers/atomic-to-decimal.js.flow

The Common package of Yoroi SDK

/**
 * Flowtype definitions for atomic-to-decimal
 * Generated by Flowgen from a Typescript Definition
 * Flowgen v1.21.0
 */

import { BigNumber } from "bignumber.js";

/**
 * Converts an atomic value to its decimal representation.
 * @param {object} options - The options for the conversion.
 * @param {string} options.value - The atomic value to convert,
 * exponential e.g 1e+4 will result in 14, only numbers are taken, negative sign is ignored.
 * @param {number} options.decimals - The number of decimal places (positive), it will round down (BigNumber.ROUND_DOWN).
 * @returns {BigNumber} The decimal representation from the atomic value.
 */
declare export function atomicToDecimal(x: {
  value: string | bigint,
  decimals: number,
  ...
}): BigNumber;