Blame view

天文台pc/tianwentai-ui/node_modules/date-fns/setDefaultOptions.d.mts 1.51 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
42
43
44
45
46
47
  import type { DefaultOptions } from "./_lib/defaultOptions.js";
  /**
   * @name setDefaultOptions
   * @category Common Helpers
   * @summary Set default options including locale.
   * @pure false
   *
   * @description
   * Sets the defaults for
   * `options.locale`, `options.weekStartsOn` and `options.firstWeekContainsDate`
   * arguments for all functions.
   *
   * @param options - An object with options
   *
   * @example
   * // Set global locale:
   * import { es } from 'date-fns/locale'
   * setDefaultOptions({ locale: es })
   * const result = format(new Date(2014, 8, 2), 'PPPP')
   * //=> 'martes, 2 de septiembre de 2014'
   *
   * @example
   * // Start of the week for 2 September 2014:
   * const result = startOfWeek(new Date(2014, 8, 2))
   * //=> Sun Aug 31 2014 00:00:00
   *
   * @example
   * // Start of the week for 2 September 2014,
   * // when we set that week starts on Monday by default:
   * setDefaultOptions({ weekStartsOn: 1 })
   * const result = startOfWeek(new Date(2014, 8, 2))
   * //=> Mon Sep 01 2014 00:00:00
   *
   * @example
   * // Manually set options take priority over default options:
   * setDefaultOptions({ weekStartsOn: 1 })
   * const result = startOfWeek(new Date(2014, 8, 2), { weekStartsOn: 0 })
   * //=> Sun Aug 31 2014 00:00:00
   *
   * @example
   * // Remove the option by setting it to `undefined`:
   * setDefaultOptions({ weekStartsOn: 1 })
   * setDefaultOptions({ weekStartsOn: undefined })
   * const result = startOfWeek(new Date(2014, 8, 2))
   * //=> Sun Aug 31 2014 00:00:00
   */
  export declare function setDefaultOptions(options: DefaultOptions): void;