timepiece/node_modules/date-fns/closestTo.mjs

58 lines
1.6 KiB
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { constructFrom } from "./constructFrom.mjs";
import { toDate } from "./toDate.mjs";
/**
* @name closestTo
* @category Common Helpers
* @summary Return a date from the array closest to the given date.
*
* @description
* Return a date from the array closest to the given date.
*
* @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 dateToCompare - The date to compare with
* @param dates - The array to search
*
* @returns The date from the array closest to the given date or undefined if no valid value is given
*
* @example
* // Which date is closer to 6 September 2015: 1 January 2000 or 1 January 2030?
* const dateToCompare = new Date(2015, 8, 6)
* const result = closestTo(dateToCompare, [
* new Date(2000, 0, 1),
* new Date(2030, 0, 1)
* ])
* //=> Tue Jan 01 2030 00:00:00
*/
export function closestTo(dateToCompare, dates) {
const date = toDate(dateToCompare);
if (isNaN(Number(date))) return constructFrom(dateToCompare, NaN);
const timeToCompare = date.getTime();
let result;
let minDistance;
dates.forEach((dirtyDate) => {
const currentDate = toDate(dirtyDate);
if (isNaN(Number(currentDate))) {
result = constructFrom(dateToCompare, NaN);
minDistance = NaN;
return;
}
const distance = Math.abs(timeToCompare - currentDate.getTime());
if (result == null || distance < minDistance) {
result = currentDate;
minDistance = distance;
}
});
return result;
}
// Fallback for modularized imports:
export default closestTo;