Blame view

天文台pc/tianwentai-ui/node_modules/date-fns/getWeeksInMonth.d.mts 1.18 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
  import type { LocalizedOptions, WeekOptions } from "./types.js";
  /**
   * The {@link getWeeksInMonth} function options.
   */
  export interface GetWeeksInMonthOptions
    extends LocalizedOptions<"options">,
      WeekOptions {}
  /**
   * @name getWeeksInMonth
   * @category Week Helpers
   * @summary Get the number of calendar weeks a month spans.
   *
   * @description
   * Get the number of calendar weeks the month in the given date spans.
   *
   * @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 date - The given date
   * @param options - An object with options.
   *
   * @returns The number of calendar weeks
   *
   * @example
   * // How many calendar weeks does February 2015 span?
   * const result = getWeeksInMonth(new Date(2015, 1, 8))
   * //=> 4
   *
   * @example
   * // If the week starts on Monday,
   * // how many calendar weeks does July 2017 span?
   * const result = getWeeksInMonth(new Date(2017, 6, 5), { weekStartsOn: 1 })
   * //=> 6
   */
  export declare function getWeeksInMonth<DateType extends Date>(
    date: DateType | number | string,
    options?: GetWeeksInMonthOptions,
  ): number;