minutes.js

Minutes.js is a JavaScript library for working with minutes. Put minutes in, and get a string representing those minutes in weeks, days, hours and minutes.

Install

$ npm install minutes.js
$ bower install minutes.js

Supports browser, Node.js and AMD (and ES6 packages via src/minutes.js).

API

var minutes = new Minutes(10),
    hours = new Minutes(2*60+50),
    days = new Minutes(2*24*60+9*60+30),
    weeks = new Minutes(2*7*24*60+6*24*60+7*60+40);

minutes.toString(); // 10 minutes
hours.toString(); // 2 hours and 50 minutes
days.toString(); // 2 days, 6 hours and 30 minutes
weeks.toString(); // 2 weeks, 6 days, 7 hours and 40 minutes

Options

Minutes takes an options Object. They're all optional.

Units

units is an Object that will define the strings used to represent the units. By default, these strings are verbose:

units: {
    'm': 'minute',
    'h': 'hour',
    'd': 'day',
    'w': 'week'
}

You can customise these to anything you like:

var opts = {
        units: {
            'm': 'min',
            'h': 'hr',
            'd': 'day',
            'w': 'wk'
        }
    },
    minutes = new Minutes(10, opts),
    hours = new Minutes(2*60+50, opts),
    days = new Minutes(2*24*60+9*60+30, opts),
    weeks = new Minutes(2*7*24*60+6*24*60+7*60+40, opts);

minutes.toString(); // 10 mins
hours.toString(); // 2 hrs and 50 mins
days.toString(); // 2 days, 6 hrs and 30 mins
weeks.toString(); // 2 wks, 6 days, 7 hrs and 40 mins

Pluralize

pluralize is a boolean that will determine if the strings used to represent a unit should be pluralized if there is more than one of a particular unit. pluralize is true by default to produce 2 hours and 1 minute.

You can alter this:

var opts = {
        units: {
            'm': 'min',
            'h': 'hr',
            'd': 'day',
            'w': 'wk'
        },
        pluralize: false
    },
    minutes = new Minutes(10, opts),
    hours = new Minutes(2*60+50, opts),
    days = new Minutes(2*24*60+9*60+30, opts),
    weeks = new Minutes(2*7*24*60+6*24*60+7*60+40, opts);

minutes.toString(); // 10 min
hours.toString(); // 2 hr and 50 min
days.toString(); // 2 day, 6 hr and 30 min
weeks.toString(); // 2 wk, 6 day, 7 hr and 40 min

Tokens

tokens is an Object that represents the strings used between the various units. The default is:

tokens: {
    'space': ' ',
    'comma': ', ',
    'and': 'and ',
    'plural': 's'
}

You can customise this to produce:

var opts = {
        units: {
            'm': 'm',
            'h': 'h',
            'd': 'd',
            'w': 'w'
        },
        pluralize: false,
        tokens: {
            space: '',
            comma: ' ',
            and: ' '
        }
    },
    minutes = new Minutes(10, opts),
    hours = new Minutes(2*60+50, opts),
    days = new Minutes(2*24*60+9*60+30, opts),
    weeks = new Minutes(2*7*24*60+6*24*60+7*60+40, opts);

minutes.toString(); // 10m
hours.toString(); // 2h 50m
days.toString(); // 2d 6h 30m
weeks.toString(); // 2w 6d 7h 40m

Or something else:

var opts = {
        units: {
            'm': '',
            'h': '',
            'd': '',
            'w': ''
        },
        pluralize: false,
        tokens: {
            space: '',
            comma: '.',
            and: '.'
        }
    },
    minutes = new Minutes(10, opts),
    hours = new Minutes(2*60+50, opts),
    days = new Minutes(2*24*60+9*60+30, opts),
    weeks = new Minutes(2*7*24*60+6*24*60+7*60+40, opts);

minutes.toString(); // 10m
hours.toString(); // 2h:50m
days.toString(); // 2d:6h:30m
weeks.toString(); // 2w:6h:7h:40m

Display

display is an Object which dictates the units to be displayed. It defaults to all units:

display: {
    'm': true,
    'h': true,
    'd': true,
    'w': true
}

You can change this to display only certain units:

var opts = {
        display: {
            'm': 'min',
            'h': 'hr',
            'd': 'day',
            'w': 'wk'
        }
    },
    minutes = new Minutes(10, {
        display: {
            'h': false,
            'd': false,
            'w': false
        }
    }),
    hours = new Minutes(2*60+50, {
        display: {
            'm': false,
            'd': false,
            'w': false
        }
    }),
    days = new Minutes(1*24*60+9*60+30, {
        display: {
            'm': false,
            'h': false,
            'w': false
        }
    }),
    weeks = new Minutes(3*7*24*60+6*24*60+7*60+40, {
        display: {
            'm': false,
            'h': false,
            'd': false
        }
    });

minutes.toString(); // 10 minutes
hours.toString(); // 2 hours
days.toString(); // 1 day
weeks.toString(); // 3 weeks

Change log

Review the change log for all changes.

License

MIT