Skip to content
Formats raw Lisk amounts to be more human-readable. Adds decimal point and commas where necessary.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
src
.babelrc
CHANGELOG.md
LICENSE
README.md
package.json
test.js

README.md

lisk-prettify

Format raw Lisk amounts to be more human-readable. Adds decimal point and commas where necessary.

e.g. 100251338358 becomes 1,002.51338358

Install

npm install --save lisk-prettify

Include in scripts

// require
var liskPrettify = require('lisk-prettify').liskPrettify

// require (ES6 version)
const { liskPrettify } = require('lisk-prettify')

// import
import liskPrettify from 'liskPrettify'

Usage Example

liskPrettify(100251338358)
// "1,002.51338358"

API

liskPrettify(rawLskValue, config <optional>)

Parameters

rawLskValue (number) - The raw LSK amount, usually returned when performing API calls to the Lisk network.

config (object) <optional> - Configuration for the returned result. The configurations are:

  • commas (boolean) - Choose whether or not to display commas where necessary e.g. 1,000,000.00000000. Default: true
  • decimals (boolean) - Choose whether or not to display decimal places. Default: true

Examples

Prettify a LSK amount

liskPrettify(100251338358)
// Result: "1,002.51338358"
// returns a string

Prettify a LSK amount without commas

liskPrettify(100251338358, { commas: false })
// Result: 1002.51338358
// returns a number

Prettify a LSK amount without decimal places

liskPrettify(100251338358, { decimals: false })
// Result: "1,002"

Tests

/* run this command inside lisk-prettify's
   node_modules folder */

npm run test

Feedback

Pull requests and opened issues are welcome!

License

MIT

You can’t perform that action at this time.