human-unit

Unit formatter for human

Install

npm install human-unit

Usage

- File size

import humanUnit, {sizePreset} from 'human-unit'
humanUnit(1024, sizePreset)  // {value: 1, unit: 'KB'}
humanUnit(1024, {unit: 'MB', ...sizePreset})  // {value: 1, unit: 'GB'}
// change units as you need
humanUnit(1024, {
    unit: 'M',
    units: ['M', 'G'],
    factors: [1024]
})
// {value: 1, unit: 'G'}

- Time unit

import humanUnit from 'human-unit'
const timePreset = {
    factors: [1000, 60, 60, 24],
    units: ['mili', 'sec', 'min', 'hour', 'day']
}
humanUnit(18000, {unit: 'sec', ...timePreset})  // {value: 5, unit: 'hour'}
humanUnit(60000, timePreset)  // {value: 1, unit: 'min'}

API

humanUnit(value: number, options?:IOptions)

return { value: number; unit: string; }

interface IOptions {
    unit?: string | undefined,
    units?: string[];  // array of units, must contain unit arg
    factors?: number | number[]; // factor for All/Each units
    ceils?: number | number[];  // ceil for All/Each units
}

The factors is the divider when bumpping units levels, can be a fixed number like in file size of 1024, or can be array of numbers like in time units.

The ceils value will be used to determine whether the unit should be bumped into next level, say, ceils: [10240], will allow the result: {value: 10000, unit: 'MB'}, better for human control.

Note

The file size calculation is easy if you look into the rule, I want to use SI standard when below GB, so the units is B,KB,MB,GB (notice the KB is not kB), but when the size is very big, after GB I want to use IEC standard, this is why the factors is array of numbers by default that changed from 1024 to 1000 after GB.