43 lines
1.2 KiB
JavaScript
43 lines
1.2 KiB
JavaScript
import { getRoundingMethod } from "./_lib/getRoundingMethod.js";
|
|
import { normalizeDates } from "./_lib/normalizeDates.js";
|
|
import { millisecondsInHour } from "./constants.js";
|
|
|
|
/**
|
|
* The {@link differenceInHours} function options.
|
|
*/
|
|
|
|
/**
|
|
* @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 laterDate - The later date
|
|
* @param earlierDate - The earlier date
|
|
* @param options - An object with options.
|
|
*
|
|
* @returns The number of hours
|
|
*
|
|
* @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 function differenceInHours(laterDate, earlierDate, options) {
|
|
const [laterDate_, earlierDate_] = normalizeDates(
|
|
options?.in,
|
|
laterDate,
|
|
earlierDate,
|
|
);
|
|
const diff = (+laterDate_ - +earlierDate_) / millisecondsInHour;
|
|
return getRoundingMethod(options?.roundingMethod)(diff);
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default differenceInHours;
|