40 lines
1.2 KiB
JavaScript
40 lines
1.2 KiB
JavaScript
|
import { getRoundingMethod } from "./_lib/getRoundingMethod.mjs";
|
||
|
|
import { differenceInMilliseconds } from "./differenceInMilliseconds.mjs";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The {@link differenceInSeconds} function options.
|
||
|
|
*/
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name differenceInSeconds
|
||
|
|
* @category Second Helpers
|
||
|
|
* @summary Get the number of seconds between the given dates.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Get the number of seconds 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 seconds
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // How many seconds are between
|
||
|
|
* // 2 July 2014 12:30:07.999 and 2 July 2014 12:30:20.000?
|
||
|
|
* const result = differenceInSeconds(
|
||
|
|
* new Date(2014, 6, 2, 12, 30, 20, 0),
|
||
|
|
* new Date(2014, 6, 2, 12, 30, 7, 999)
|
||
|
|
* )
|
||
|
|
* //=> 12
|
||
|
|
*/
|
||
|
|
export function differenceInSeconds(dateLeft, dateRight, options) {
|
||
|
|
const diff = differenceInMilliseconds(dateLeft, dateRight) / 1000;
|
||
|
|
return getRoundingMethod(options?.roundingMethod)(diff);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default differenceInSeconds;
|