@spa-tools/utilities
humanizeHrs()
The humanizeHrs()
function converts a number of hours into the largest applicable
unit of either year, month, week, or day.
Usage
import { humanizeHrs } from '@spa-tools/utilities';
const humanizeHrs1 = humanizeHrs(8760, 0);
console.log(humanizeHrs1);
// --> [1, 'year']
const humanizeHrs2 = humanizeHrs(730);
console.log(humanizeHrs2);
// --> [1, 'month']
const humanizeHrs3 = humanizeHrs(168, 0);
console.log(humanizeHrs3);
// --> [1, 'week']
const humanizeHrs4 = humanizeHrs(24);
console.log(humanizeHrs4);
// --> [1, 'day']
const humanizeHrs5 = humanizeHrs(123456, 2);
console.log(humanizeHrs5);
// --> [14.09, 'years']
Arguments
Name | Type | Required? | Default | Description |
---|---|---|---|---|
hours | number | yes | - | The hours to humanize |
decimalPlaces | number | no | 1 | The decimal places to round/format to |
Returns
Returns two-element tuple as follows:
- element 1 at index 0 =
number
representing the converted-to value with requested decimal places - element 2 at index 1 =
string
representing the converted-to unit