55 lines
1.7 KiB
JavaScript
55 lines
1.7 KiB
JavaScript
|
import toDate from '../toDate/index.js';
|
||
|
|
/**
|
||
|
|
* @name compareDesc
|
||
|
|
* @category Common Helpers
|
||
|
|
* @summary Compare the two dates reverse chronologically and return -1, 0 or 1.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Compare the two dates and return -1 if the first date is after the second,
|
||
|
|
* 1 if the first date is before the second or 0 if dates are equal.
|
||
|
|
*
|
||
|
|
* ### v2.0.0 breaking changes:
|
||
|
|
*
|
||
|
|
* - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
|
||
|
|
*
|
||
|
|
* @param {Date|Number} dateLeft - the first date to compare
|
||
|
|
* @param {Date|Number} dateRight - the second date to compare
|
||
|
|
* @returns {Number} the result of the comparison
|
||
|
|
* @throws {TypeError} 2 arguments required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Compare 11 February 1987 and 10 July 1989 reverse chronologically:
|
||
|
|
* var result = compareDesc(new Date(1987, 1, 11), new Date(1989, 6, 10))
|
||
|
|
* //=> 1
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Sort the array of dates in reverse chronological order:
|
||
|
|
* var result = [
|
||
|
|
* new Date(1995, 6, 2),
|
||
|
|
* new Date(1987, 1, 11),
|
||
|
|
* new Date(1989, 6, 10)
|
||
|
|
* ].sort(compareDesc)
|
||
|
|
* //=> [
|
||
|
|
* // Sun Jul 02 1995 00:00:00,
|
||
|
|
* // Mon Jul 10 1989 00:00:00,
|
||
|
|
* // Wed Feb 11 1987 00:00:00
|
||
|
|
* // ]
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function compareDesc(dirtyDateLeft, dirtyDateRight) {
|
||
|
|
if (arguments.length < 2) {
|
||
|
|
throw new TypeError('2 arguments required, but only ' + arguments.length + ' present');
|
||
|
|
}
|
||
|
|
|
||
|
|
var dateLeft = toDate(dirtyDateLeft);
|
||
|
|
var dateRight = toDate(dirtyDateRight);
|
||
|
|
var diff = dateLeft.getTime() - dateRight.getTime();
|
||
|
|
|
||
|
|
if (diff > 0) {
|
||
|
|
return -1;
|
||
|
|
} else if (diff < 0) {
|
||
|
|
return 1; // Return 0 if diff is 0; return NaN if diff is NaN
|
||
|
|
} else {
|
||
|
|
return diff;
|
||
|
|
}
|
||
|
|
}
|