| Path : /var/www/html/tool-ob/ToolsPortal/node_modules/date-fns/ |
|
B-Con CMD Config cPanel C-Rdp D-Log Info Jump Mass Ransom Symlink vHost Zone-H |
| Current File : /var/www/html/tool-ob/ToolsPortal/node_modules/date-fns/closestIndexTo.d.mts |
/** * @name closestIndexTo * @category Common Helpers * @summary Return an index of the closest date from the array comparing to the given date. * * @description * Return an index of the closest date from the array comparing 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 An index of the date closest to the given date or undefined if no valid value is given * * @example * // Which date is closer to 6 September 2015? * const dateToCompare = new Date(2015, 8, 6) * const datesArray = [ * new Date(2015, 0, 1), * new Date(2016, 0, 1), * new Date(2017, 0, 1) * ] * const result = closestIndexTo(dateToCompare, datesArray) * //=> 1 */ export declare function closestIndexTo<DateType extends Date>( dateToCompare: DateType | number | string, dates: Array<DateType | number | string>, ): number | undefined;