Blame view

天文台pc/tianwentai-ui/node_modules/date-fns/getWeekOfMonth.d.mts 972 Bytes
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
  import type { LocalizedOptions, WeekOptions } from "./types.js";
  /**
   * The {@link getWeekOfMonth} function options.
   */
  export interface GetWeekOfMonthOptions
    extends LocalizedOptions<"options">,
      WeekOptions {}
  /**
   * @name getWeekOfMonth
   * @category Week Helpers
   * @summary Get the week of the month of the given date.
   *
   * @description
   * Get the week of the month of 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 date - The given date
   * @param options - An object with options.
   *
   * @returns The week of month
   *
   * @example
   * // Which week of the month is 9 November 2017?
   * const result = getWeekOfMonth(new Date(2017, 10, 9))
   * //=> 2
   */
  export declare function getWeekOfMonth<DateType extends Date>(
    date: DateType | number | string,
    options?: GetWeekOfMonthOptions,
  ): number;