29 lines
955 B
TypeScript
29 lines
955 B
TypeScript
|
/**
|
||
|
|
* @name differenceInMilliseconds
|
||
|
|
* @category Millisecond Helpers
|
||
|
|
* @summary Get the number of milliseconds between the given dates.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Get the number of milliseconds 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
|
||
|
|
*
|
||
|
|
* @returns The number of milliseconds
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // How many milliseconds are between
|
||
|
|
* // 2 July 2014 12:30:20.600 and 2 July 2014 12:30:21.700?
|
||
|
|
* const result = differenceInMilliseconds(
|
||
|
|
* new Date(2014, 6, 2, 12, 30, 21, 700),
|
||
|
|
* new Date(2014, 6, 2, 12, 30, 20, 600)
|
||
|
|
* )
|
||
|
|
* //=> 1100
|
||
|
|
*/
|
||
|
|
export declare function differenceInMilliseconds<DateType extends Date>(
|
||
|
|
dateLeft: DateType | number | string,
|
||
|
|
dateRight: DateType | number | string,
|
||
|
|
): number;
|