Blame view

天文台pc/tianwentai-ui/node_modules/date-fns/closestIndexTo.d.ts 1.07 KB
bc518174   王天杨   提交两个项目文件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
  /**
   * @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;