Blame view

天文台pc/tianwentai-ui/node_modules/date-fns/formatRelative.mjs 2.98 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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
  import { differenceInCalendarDays } from "./differenceInCalendarDays.mjs";
  import { format } from "./format.mjs";
  import { toDate } from "./toDate.mjs";
  import { defaultLocale } from "./_lib/defaultLocale.mjs";
  import { getDefaultOptions } from "./_lib/defaultOptions.mjs";
  
  /**
   * The {@link formatRelative} function options.
   */
  
  /**
   * @name formatRelative
   * @category Common Helpers
   * @summary Represent the date in words relative to the given base date.
   *
   * @description
   * Represent the date in words relative to the given base date.
   *
   * | Distance to the base date | Result                    |
   * |---------------------------|---------------------------|
   * | Previous 6 days           | last Sunday at 04:30 AM   |
   * | Last day                  | yesterday at 04:30 AM     |
   * | Same day                  | today at 04:30 AM         |
   * | Next day                  | tomorrow at 04:30 AM      |
   * | Next 6 days               | Sunday at 04:30 AM        |
   * | Other                     | 12/31/2017                |
   *
   * @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 date to format
   * @param baseDate - The date to compare with
   * @param options - An object with options
   *
   * @returns The date in words
   *
   * @throws `date` must not be Invalid Date
   * @throws `baseDate` must not be Invalid Date
   * @throws `options.locale` must contain `localize` property
   * @throws `options.locale` must contain `formatLong` property
   * @throws `options.locale` must contain `formatRelative` property
   *
   * @example
   * // Represent the date of 6 days ago in words relative to the given base date. In this example, today is Wednesday
   * const result = formatRelative(subDays(new Date(), 6), new Date())
   * //=> "last Thursday at 12:45 AM"
   */
  export function formatRelative(date, baseDate, options) {
    const _date = toDate(date);
    const _baseDate = toDate(baseDate);
  
    const defaultOptions = getDefaultOptions();
    const locale = options?.locale ?? defaultOptions.locale ?? defaultLocale;
    const weekStartsOn =
      options?.weekStartsOn ??
      options?.locale?.options?.weekStartsOn ??
      defaultOptions.weekStartsOn ??
      defaultOptions.locale?.options?.weekStartsOn ??
      0;
  
    const diff = differenceInCalendarDays(_date, _baseDate);
  
    if (isNaN(diff)) {
      throw new RangeError("Invalid time value");
    }
  
    let token;
    if (diff < -6) {
      token = "other";
    } else if (diff < -1) {
      token = "lastWeek";
    } else if (diff < 0) {
      token = "yesterday";
    } else if (diff < 1) {
      token = "today";
    } else if (diff < 2) {
      token = "tomorrow";
    } else if (diff < 7) {
      token = "nextWeek";
    } else {
      token = "other";
    }
  
    const formatStr = locale.formatRelative(token, _date, _baseDate, {
      locale,
      weekStartsOn,
    });
    return format(_date, formatStr, { locale, weekStartsOn });
  }
  
  // Fallback for modularized imports:
  export default formatRelative;