Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kilkelly/nano-prettify
Format Nano (formally RaiBlocks) raw amounts to be more human-readable.
https://github.com/kilkelly/nano-prettify
crypto cryptocurrency nano nano-currency nanocurrency raiblocks xrb
Last synced: about 1 month ago
JSON representation
Format Nano (formally RaiBlocks) raw amounts to be more human-readable.
- Host: GitHub
- URL: https://github.com/kilkelly/nano-prettify
- Owner: kilkelly
- License: mit
- Created: 2018-02-01T20:39:56.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2021-07-27T06:00:41.000Z (over 3 years ago)
- Last Synced: 2024-11-12T19:26:16.057Z (about 2 months ago)
- Topics: crypto, cryptocurrency, nano, nano-currency, nanocurrency, raiblocks, xrb
- Language: JavaScript
- Homepage:
- Size: 153 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# nano-prettify
Prettify / format Nano (formally RaiBlocks) Raw amounts to be more human-readable. Format amounts in any Nano compatible unit e.g. unano, Gnano etc.... Adds decimal point and commas where necessary. Raw amounts are commonly returned when interacting with a Nano node.
e.g. Raw amount "2100176034320859259343606608761791" becomes "2,100.176034"
## Install
```sh
npm install --save nano-prettify
```
## Include in scripts
```sh
// require
var nanoPrettify = require('nano-prettify').nanoPrettify
// require (ES6 version)
const { nanoPrettify } = require('nano-prettify')
// import
import nanoPrettify from 'nano-prettify'
```
## Usage Example
```sh
nanoPrettify("2100176034320859259343606608761791")
// "2,100.176034"
```
## Note
**nano-prettify** works with strings only. If you need to deal with numbers you can try converting a returned result to a numeric format using parseInt or parseFloat where applicable.
## API
### nanoPrettify(raw, config <optional>)
**Parameters**
**raw** *(string)* - The Raw amount to format. This is commonly returned when performing API calls to a Nano node e.g. "2100176034320859259343606608761791"
**config** *(object)* <optional> - Configuration for the returned result. The configurations are:
* **unit** *(Possible values: 'raw', 'unano', 'mnano', 'nano', 'knano', 'Mnano', 'Gnano')* - Specify which Nano unit is used to prettify the Raw amount. Default unit is 'Mnano'.
* **commas** *(boolean)* - Choose whether or not to display commas where necessary e.g. "1,000,000.000000". Default: true
* **decimals** *(boolean)* - Choose whether or not to display decimal places. Default: true
* **decimalPlaces** *(number)* - Number of decimal places to display. Default is 6. Enter 0 to show all decimal places.
#### Examples
Prettify a Raw amount
```sh
nanoPrettify("2100176034320859259343606608761791")
// Result: "2,100.176034"
```
Prettify a Raw amount using the 'nano' unit (overridiing the default unit 'Mnano')
```sh
nanoPrettify("2100176034320859259343606608761791", { unit: 'nano' })
// Result: "2,100,176,034.320859"
```
Prettify a Raw amount without commas
```sh
nanoPrettify("2100176034320859259343606608761791", { commas: false })
// Result: "2100.176034"
```
Prettify a Raw amount without decimal places
```sh
nanoPrettify("2100176034320859259343606608761791", { decimals: false })
// Result: "2,100"
```
Prettify a Raw amount with 10 decimal places (overriding the default of 6 decimal places)
```sh
nanoPrettify("2100176034320859259343606608761791", { decimalPlaces: 10 })
// Result: "2,100.1760343208"
```
Prettify a Raw amount using a combination of configurations
```sh
nanoPrettify("2100176034320859259343606608761791",
{
commas: false,
decimals: true,
unit: 'nano',
decimalPlaces: 10
}
)
// Result: "2100176034.3208592593"
```
## Tests
```sh
/* run this command inside nano-prettify's
node_modules folder */
npm run test
```
## Feedback
Pull requests and opened issues are welcome!
## License
MIT