unitage v1.0.0

unitage

Unit conversion to shorten long number:

const unitage = require('unitage');

const num = new unitage(100000, ['', 'k'], 1000);

num.toString(); // '100k'

Installation

npm install unitage -S

Usage

Create instance:

const unitage = require('unitage');

unitage(1000, ['', 'k'], 1000);

// same as

new untiage(1000, ['', 'k'], 1000);

Define a unit converter:

const unitage = require('unitage');

const byte = unitage.define(['b', 'kb', 'mb'], 1024);

byte(1).toString(); // '1b'
byte(1024).toString(); // '1kb'
byte(4194304).toString(); // '4mb'

unitage.define(func)would return a function which accepts value parameter and return a unitage instance.

Each unit can be configured with different multiples:

const unitage = require('unitage');

const level = unitage.define(['', {
    unit: 'hundred',
    step: 100
}, {
    unit: 'thousand',
    step: 10
}, {
    unit: 'million'，
    step: 1000
}]);

level(1).toString(); // '1'
level(120).toString(); // '1.2hundred'
level(13000).toString(); // '13thousand'
level(4300000).toString(); // '4.3million'

Status

• value: actual value
• number: display value
• unit: current unit

const unitage = require('unitage');

const num = unitage(1200, ['b', 'kb', 'mb'], 1024);

num.toString(); // '1.17kb'

num.value === 1200;
num.number === 1.171875;
num.unit === 'kb';

Methods

• toString([unit=this.unit, maxDigits=2])

  const unitage = require('unitage');
  
  const num = unitage(1200, ['b', 'kb', 'mb'], 1024);
  
  String(num) === (num + '') === num.toString(); // '1.17kb'
  
  num.toString(4); // '1.1719kb'
  num.toString('mb'); // '0mb'
  num.toString('mb', Infinity); // '0.0011444091796875mb'

• tryUnit(unit): Try the max unit while ensure the display value is not less than 1

  const unitage = require('unitage');
  
  const num = unitage(1200, ['b', 'kb', 'mb'], 1024);
  
  String(num); // '1.17kb'
  
  num.tryUnit('b');
  
  num.toString(); // '1200b'
  
  num.tryUnit('mb');
  
  num.toString(); // '1.17kb'

• setUnit(unit): specify unit

  const unitage = require('unitage');
  
  const num = unitage(1200, ['b', 'kb', 'mb'], 1024);
  
  String(num); // '1.17kb'
  
  num.setUnit('mb');
  
  num.toString(Infinity); // '0.0011444091796875mb'

• setValue(value): specify the actual value

  const unitage = require('unitage');
  
  const num = unitage(1200, ['b', 'kb', 'mb'], 1024);
  
  String(num); // '1.17kb'
  
  num.setValue(1024);
  
  num.toString(); // '1kb'

• setNumber(value): specify the display value

  const unitage = require('unitage');
  
  const num = unitage(1200, ['b', 'kb', 'mb'], 1024);
  
  String(num); // '1.17kb'
  
  num.setNumber(2);
  
  num.toString(); // '2kb'
  
  num.number; // 2
  
  num.value; // 2048
  
  num.unit; // 'kb'

• getNumber(unit=this.unit, maxDigits=2): get the display value

  const unitage = require('unitage');
  
  const num = unitage(1200, ['b', 'kb', 'mb'], 1024);
  
  String(num); // '1.17kb'
  
  num.getNumber() === num.number; // 1.17
  
  num.getNumber('b'); // 1200
  
  num.getNumber('mb', Infinity); // 0.0011444091796875