📝 Commit Details:
This commit is contained in:
29
backend/node_modules/date-fns/closestIndexTo.d.ts
generated
vendored
Normal file
29
backend/node_modules/date-fns/closestIndexTo.d.ts
generated
vendored
Normal file
@@ -0,0 +1,29 @@
|
||||
import type { DateArg } from "./types.js";
|
||||
/**
|
||||
* @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.
|
||||
*
|
||||
* @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(
|
||||
dateToCompare: DateArg<Date> & {},
|
||||
dates: Array<DateArg<Date> & {}>,
|
||||
): number | undefined;
|
Reference in New Issue
Block a user