humanise-duration v1.0.2

humanise-duration

Provides a function that accepts a duration in milliseconds and returns a "humanised" form in the nearest unit (seconds, minutes, hours or days) with the specified number of decimal places.

basic usage

import humaniseDuration from 'humanise-duration';

const EXAMPLE_DURATION_1 = 1903124;
const EXAMPLE_DURATION_2 = 86400003;
const EXAMPLE_DURATION_3 = 4007;

let result1 = humaniseDuration(EXAMPLE_DURATION_1); // "31.7 minutes"
let result2 = humaniseDuration(EXAMPLE_DURATION_2); // "1 day"
let result3 = humaniseDuration(EXAMPLE_DURATION_3); // "4 seconds"

usage with options

options:
{
    decimalPlaces:   0-3        (default: 1)      -- the number of decimal places attached to the result
    forceDecimal:    true/false (default: false)  -- whether to include trailing zeroes on round numbers, or leave them as integers
    includeSingular: true/false (default: true)   -- whether to express unit quantities as singular (e.g. 1 minute)
}

import humaniseDuration from 'humanise-duration';

const EXAMPLE_OPTIONS = {
	decimalPlaces: 2,
	forceDecimal: true,
	includeSingular: false
}

const EXAMPLE_DURATION_1 = 1903124;
const EXAMPLE_DURATION_2 = 86400003;
const EXAMPLE_DURATION_3 = 4007;

let result1 = humaniseDuration(EXAMPLE_DURATION_1, EXAMPLE_OPTIONS); // "31.71 minutes"
let result2 = humaniseDuration(EXAMPLE_DURATION_2, EXAMPLE_OPTIONS); // "1.00 days"
let result3 = humaniseDuration(EXAMPLE_DURATION_3, EXAMPLE_OPTIONS); // "4.01 seconds"