timeDuration

Library to handle simple hour/minute times, with minutes as basic units.

installation

npm i time-duration with --save-dev if desired

usage

This lib is based on an instantiable class, to deal with time in the scope of minutes and hours. It supports time to be supplied to it in 4 basic ways:

const td = new TimeDuration('2:30'); // string with hours and minutes
const td = new TimeDuration({ hours: 2, minutes: 30 }); // object
const td = new TimeDuration(2, 30); // two parameters: hours, minutes
const td = new TimeDuration(210); // number of minutes

Also, time can be supplied as a difference between two native Date objects (in this case it will calculate the minutes not with getMinutes() but based on both milliseconds):

const date1 = new Date(2018, 0, 1, 12, 45, 54);
const date2 = new Date(2018, 0, 1, 14, 20, 15);
const td = new TimeDuration(date1, date2);

With this class instantiated, one can process time calculations with minutes and hours and output it as a number of formats. The formats are as follows:

const td = new TimeDuration(2, 30);
console.log(td + 0); // outputs 210 (integer)
console.log(td.valueOf()); // outputs 210, same as above
console.log(td.toMinutes()); // outputs 210, just as above
console.log(td.toString()); // outputs "2:30"
console.log(td.toHours(1)); // outputs 2.5 (float -the parameter tells the round precision)
console.log(td.toObject()); // outputs an object { hours: 2, minutes: 30 }

The processing functions built out of the box: (On add and subtract the parameter will be converted to a TimeDuration, whereas on multiplyBy and divideBy the parameter will be the multiplication/division factor)

const td = new TimeDuration(2, 30);

console.log(td.add(10)); // outputs "2:40"
console.log(td.add('1:00')); // outputs "3:30"
console.log(td.subtract(1, 0)); // outputs "1:30"
console.log(td.subtract({ hours: 0, minutes: 20 })); // outputs "2:10"
console.log(td.multiplyBy(3)); // outputs "7:30"
console.log(td.divideBy(2)); // outputs "1:15"

Alternatively, one can do mathematical operations with TimeDurations:

const td1 = new TimeDuration(1, 20);
const td2 = new TimeDuration(1, 00);
console.log(td1 + td2); // outputs 140 (integer)
console.log(new TimeDuration(td1 - td2)); // outputs "0:20"

testing and linting

npm test

Tests include linting, but when only the linting is desired the command npm run lint can be run.