1.0.0-beta.30 • Published 4 years ago

@iota/unit-converter v1.0.0-beta.30

Weekly downloads
32
License
MIT
Repository
github
Last release
4 years ago

@iota/unit-converter

Converts value across different IOTA units.

Installation

Install using npm:

npm install @iota/unit-converter

or using yarn:

yarn add @iota/unit-converter

API Reference

<a name="module_unit-converter.convertUnits"></a>

unit-converter.convertUnits(value, fromUnit, toUnit)

Summary: Converts a value of IOTA tokens from one unit to another.

ParamTypeDescription
valueString | integer | floatNumber of IOTA tokens
fromUnitStringUnit of the value argument
toUnitStringUnit to which to convert the value to

This method converts a value of IOTA tokens from a given unit to another given unit.

Valid unit names include the following:

  • i: 1
  • Ki: 1,000
  • Mi: 1,000,000
  • Gi: 1,000,000,000
  • Ti: 1,000,000,000,000
  • Pi: 1,000,000,000,000,000

Returns: number - newUnit - The number of units of IOTA tokens
Example

let newUnit = UnitConverter.convertUnits(100, 'Ti', 'Pi');