49 lines
1.5 KiB
JavaScript
49 lines
1.5 KiB
JavaScript
import { getRoundingMethod } from "./_lib/getRoundingMethod.mjs";
|
|
import { millisecondsInMinute } from "./constants.mjs";
|
|
import { differenceInMilliseconds } from "./differenceInMilliseconds.mjs";
|
|
|
|
/**
|
|
* The {@link differenceInMinutes} function options.
|
|
*/
|
|
|
|
/**
|
|
* @name differenceInMinutes
|
|
* @category Minute Helpers
|
|
* @summary Get the number of minutes between the given dates.
|
|
*
|
|
* @description
|
|
* Get the signed number of full (rounded towards 0) minutes between the given dates.
|
|
*
|
|
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
|
|
*
|
|
* @param dateLeft - The later date
|
|
* @param dateRight - The earlier date
|
|
* @param options - An object with options.
|
|
*
|
|
* @returns The number of minutes
|
|
*
|
|
* @example
|
|
* // How many minutes are between 2 July 2014 12:07:59 and 2 July 2014 12:20:00?
|
|
* const result = differenceInMinutes(
|
|
* new Date(2014, 6, 2, 12, 20, 0),
|
|
* new Date(2014, 6, 2, 12, 7, 59)
|
|
* )
|
|
* //=> 12
|
|
*
|
|
* @example
|
|
* // How many minutes are between 10:01:59 and 10:00:00
|
|
* const result = differenceInMinutes(
|
|
* new Date(2000, 0, 1, 10, 0, 0),
|
|
* new Date(2000, 0, 1, 10, 1, 59)
|
|
* )
|
|
* //=> -1
|
|
*/
|
|
export function differenceInMinutes(dateLeft, dateRight, options) {
|
|
const diff =
|
|
differenceInMilliseconds(dateLeft, dateRight) / millisecondsInMinute;
|
|
return getRoundingMethod(options?.roundingMethod)(diff);
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default differenceInMinutes;
|