33 lines
1.3 KiB
JavaScript
33 lines
1.3 KiB
JavaScript
|
import { millisecondsInHour } from "../constants/index.js";
|
||
|
|
import differenceInMilliseconds from "../differenceInMilliseconds/index.js";
|
||
|
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
||
|
|
import { getRoundingMethod } from "../_lib/roundingMethods/index.js";
|
||
|
|
/**
|
||
|
|
* @name differenceInHours
|
||
|
|
* @category Hour Helpers
|
||
|
|
* @summary Get the number of hours between the given dates.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Get the number of hours between the given dates.
|
||
|
|
*
|
||
|
|
* @param {Date|Number} dateLeft - the later date
|
||
|
|
* @param {Date|Number} dateRight - the earlier date
|
||
|
|
* @param {Object} [options] - an object with options.
|
||
|
|
* @param {String} [options.roundingMethod='trunc'] - a rounding method (`ceil`, `floor`, `round` or `trunc`)
|
||
|
|
* @returns {Number} the number of hours
|
||
|
|
* @throws {TypeError} 2 arguments required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // How many hours are between 2 July 2014 06:50:00 and 2 July 2014 19:00:00?
|
||
|
|
* const result = differenceInHours(
|
||
|
|
* new Date(2014, 6, 2, 19, 0),
|
||
|
|
* new Date(2014, 6, 2, 6, 50)
|
||
|
|
* )
|
||
|
|
* //=> 12
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function differenceInHours(dateLeft, dateRight, options) {
|
||
|
|
requiredArgs(2, arguments);
|
||
|
|
var diff = differenceInMilliseconds(dateLeft, dateRight) / millisecondsInHour;
|
||
|
|
return getRoundingMethod(options === null || options === void 0 ? void 0 : options.roundingMethod)(diff);
|
||
|
|
}
|