Blame view

天文台pc/tianwentai-ui/node_modules/date-fns/getOverlappingDaysInIntervals.d.mts 1.5 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
31
32
33
34
35
36
37
38
39
40
41
  import type { Interval } from "./types.js";
  /**
   * @name getOverlappingDaysInIntervals
   * @category Interval Helpers
   * @summary Get the number of days that overlap in two time intervals
   *
   * @description
   * Get the number of days that overlap in two time intervals. It uses the time
   * between dates to calculate the number of days, rounding it up to include
   * partial days.
   *
   * Two equal 0-length intervals will result in 0. Two equal 1ms intervals will
   * result in 1.
   *
   * @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 intervalLeft - The first interval to compare.
   * @param intervalRight - The second interval to compare.
   *
   * @returns The number of days that overlap in two time intervals
   *
   * @example
   * // For overlapping time intervals adds 1 for each started overlapping day:
   * getOverlappingDaysInIntervals(
   *   { start: new Date(2014, 0, 10), end: new Date(2014, 0, 20) },
   *   { start: new Date(2014, 0, 17), end: new Date(2014, 0, 21) }
   * )
   * //=> 3
   *
   * @example
   * // For non-overlapping time intervals returns 0:
   * getOverlappingDaysInIntervals(
   *   { start: new Date(2014, 0, 10), end: new Date(2014, 0, 20) },
   *   { start: new Date(2014, 0, 21), end: new Date(2014, 0, 22) }
   * )
   * //=> 0
   */
  export declare function getOverlappingDaysInIntervals<DateType extends Date>(
    intervalLeft: Interval<DateType>,
    intervalRight: Interval<DateType>,
  ): number;