189 lines
6.1 KiB
JavaScript
189 lines
6.1 KiB
JavaScript
"use strict";
|
|
exports.formatDistanceStrict = formatDistanceStrict;
|
|
var _index = require("./_lib/defaultLocale.cjs");
|
|
var _index2 = require("./_lib/defaultOptions.cjs");
|
|
var _index3 = require("./_lib/getRoundingMethod.cjs");
|
|
var _index4 = require("./_lib/getTimezoneOffsetInMilliseconds.cjs");
|
|
var _index5 = require("./_lib/normalizeDates.cjs");
|
|
var _index6 = require("./compareAsc.cjs");
|
|
var _index7 = require("./constants.cjs");
|
|
|
|
/**
|
|
* The {@link formatDistanceStrict} function options.
|
|
*/
|
|
|
|
/**
|
|
* The unit used to format the distance in {@link formatDistanceStrict}.
|
|
*/
|
|
|
|
/**
|
|
* @name formatDistanceStrict
|
|
* @category Common Helpers
|
|
* @summary Return the distance between the given dates in words.
|
|
*
|
|
* @description
|
|
* Return the distance between the given dates in words, using strict units.
|
|
* This is like `formatDistance`, but does not use helpers like 'almost', 'over',
|
|
* 'less than' and the like.
|
|
*
|
|
* | Distance between dates | Result |
|
|
* |------------------------|---------------------|
|
|
* | 0 ... 59 secs | [0..59] seconds |
|
|
* | 1 ... 59 mins | [1..59] minutes |
|
|
* | 1 ... 23 hrs | [1..23] hours |
|
|
* | 1 ... 29 days | [1..29] days |
|
|
* | 1 ... 11 months | [1..11] months |
|
|
* | 1 ... N years | [1..N] years |
|
|
*
|
|
* @param laterDate - The date
|
|
* @param earlierDate - The date to compare with
|
|
* @param options - An object with options
|
|
*
|
|
* @returns The distance in words
|
|
*
|
|
* @throws `date` must not be Invalid Date
|
|
* @throws `baseDate` must not be Invalid Date
|
|
* @throws `options.unit` must be 'second', 'minute', 'hour', 'day', 'month' or 'year'
|
|
* @throws `options.locale` must contain `formatDistance` property
|
|
*
|
|
* @example
|
|
* // What is the distance between 2 July 2014 and 1 January 2015?
|
|
* const result = formatDistanceStrict(new Date(2014, 6, 2), new Date(2015, 0, 2))
|
|
* //=> '6 months'
|
|
*
|
|
* @example
|
|
* // What is the distance between 1 January 2015 00:00:15
|
|
* // and 1 January 2015 00:00:00?
|
|
* const result = formatDistanceStrict(
|
|
* new Date(2015, 0, 1, 0, 0, 15),
|
|
* new Date(2015, 0, 1, 0, 0, 0)
|
|
* )
|
|
* //=> '15 seconds'
|
|
*
|
|
* @example
|
|
* // What is the distance from 1 January 2016
|
|
* // to 1 January 2015, with a suffix?
|
|
* const result = formatDistanceStrict(new Date(2015, 0, 1), new Date(2016, 0, 1), {
|
|
* addSuffix: true
|
|
* })
|
|
* //=> '1 year ago'
|
|
*
|
|
* @example
|
|
* // What is the distance from 1 January 2016
|
|
* // to 1 January 2015, in minutes?
|
|
* const result = formatDistanceStrict(new Date(2016, 0, 1), new Date(2015, 0, 1), {
|
|
* unit: 'minute'
|
|
* })
|
|
* //=> '525600 minutes'
|
|
*
|
|
* @example
|
|
* // What is the distance from 1 January 2015
|
|
* // to 28 January 2015, in months, rounded up?
|
|
* const result = formatDistanceStrict(new Date(2015, 0, 28), new Date(2015, 0, 1), {
|
|
* unit: 'month',
|
|
* roundingMethod: 'ceil'
|
|
* })
|
|
* //=> '1 month'
|
|
*
|
|
* @example
|
|
* // What is the distance between 1 August 2016 and 1 January 2015 in Esperanto?
|
|
* import { eoLocale } from 'date-fns/locale/eo'
|
|
* const result = formatDistanceStrict(new Date(2016, 7, 1), new Date(2015, 0, 1), {
|
|
* locale: eoLocale
|
|
* })
|
|
* //=> '1 jaro'
|
|
*/
|
|
|
|
function formatDistanceStrict(laterDate, earlierDate, options) {
|
|
const defaultOptions = (0, _index2.getDefaultOptions)();
|
|
const locale =
|
|
options?.locale ?? defaultOptions.locale ?? _index.defaultLocale;
|
|
|
|
const comparison = (0, _index6.compareAsc)(laterDate, earlierDate);
|
|
|
|
if (isNaN(comparison)) {
|
|
throw new RangeError("Invalid time value");
|
|
}
|
|
|
|
const localizeOptions = Object.assign({}, options, {
|
|
addSuffix: options?.addSuffix,
|
|
comparison: comparison,
|
|
});
|
|
|
|
const [laterDate_, earlierDate_] = (0, _index5.normalizeDates)(
|
|
options?.in,
|
|
...(comparison > 0 ? [earlierDate, laterDate] : [laterDate, earlierDate]),
|
|
);
|
|
|
|
const roundingMethod = (0, _index3.getRoundingMethod)(
|
|
options?.roundingMethod ?? "round",
|
|
);
|
|
|
|
const milliseconds = earlierDate_.getTime() - laterDate_.getTime();
|
|
const minutes = milliseconds / _index7.millisecondsInMinute;
|
|
|
|
const timezoneOffset =
|
|
(0, _index4.getTimezoneOffsetInMilliseconds)(earlierDate_) -
|
|
(0, _index4.getTimezoneOffsetInMilliseconds)(laterDate_);
|
|
|
|
// Use DST-normalized difference in minutes for years, months and days;
|
|
// use regular difference in minutes for hours, minutes and seconds.
|
|
const dstNormalizedMinutes =
|
|
(milliseconds - timezoneOffset) / _index7.millisecondsInMinute;
|
|
|
|
const defaultUnit = options?.unit;
|
|
let unit;
|
|
if (!defaultUnit) {
|
|
if (minutes < 1) {
|
|
unit = "second";
|
|
} else if (minutes < 60) {
|
|
unit = "minute";
|
|
} else if (minutes < _index7.minutesInDay) {
|
|
unit = "hour";
|
|
} else if (dstNormalizedMinutes < _index7.minutesInMonth) {
|
|
unit = "day";
|
|
} else if (dstNormalizedMinutes < _index7.minutesInYear) {
|
|
unit = "month";
|
|
} else {
|
|
unit = "year";
|
|
}
|
|
} else {
|
|
unit = defaultUnit;
|
|
}
|
|
|
|
// 0 up to 60 seconds
|
|
if (unit === "second") {
|
|
const seconds = roundingMethod(milliseconds / 1000);
|
|
return locale.formatDistance("xSeconds", seconds, localizeOptions);
|
|
|
|
// 1 up to 60 mins
|
|
} else if (unit === "minute") {
|
|
const roundedMinutes = roundingMethod(minutes);
|
|
return locale.formatDistance("xMinutes", roundedMinutes, localizeOptions);
|
|
|
|
// 1 up to 24 hours
|
|
} else if (unit === "hour") {
|
|
const hours = roundingMethod(minutes / 60);
|
|
return locale.formatDistance("xHours", hours, localizeOptions);
|
|
|
|
// 1 up to 30 days
|
|
} else if (unit === "day") {
|
|
const days = roundingMethod(dstNormalizedMinutes / _index7.minutesInDay);
|
|
return locale.formatDistance("xDays", days, localizeOptions);
|
|
|
|
// 1 up to 12 months
|
|
} else if (unit === "month") {
|
|
const months = roundingMethod(
|
|
dstNormalizedMinutes / _index7.minutesInMonth,
|
|
);
|
|
return months === 12 && defaultUnit !== "month"
|
|
? locale.formatDistance("xYears", 1, localizeOptions)
|
|
: locale.formatDistance("xMonths", months, localizeOptions);
|
|
|
|
// 1 year up to max Date
|
|
} else {
|
|
const years = roundingMethod(dstNormalizedMinutes / _index7.minutesInYear);
|
|
return locale.formatDistance("xYears", years, localizeOptions);
|
|
}
|
|
}
|