12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788 |
- import { defaultLocale } from "./_lib/defaultLocale.js";
- import { getDefaultOptions } from "./_lib/defaultOptions.js";
- import { normalizeDates } from "./_lib/normalizeDates.js";
- import { differenceInCalendarDays } from "./differenceInCalendarDays.js";
- import { format } from "./format.js";
- /**
- * 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 |
- *
- * @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_, baseDate_] = normalizeDates(options?.in, date, 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;
|