123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232 |
- "use strict";
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.default = formatDistance;
- var _index = _interopRequireDefault(require("../compareAsc/index.js"));
- var _index2 = _interopRequireDefault(require("../differenceInMonths/index.js"));
- var _index3 = _interopRequireDefault(require("../differenceInSeconds/index.js"));
- var _index4 = _interopRequireDefault(require("../locale/en-US/index.js"));
- var _index5 = _interopRequireDefault(require("../toDate/index.js"));
- var _index6 = _interopRequireDefault(require("../_lib/cloneObject/index.js"));
- var _index7 = _interopRequireDefault(require("../_lib/getTimezoneOffsetInMilliseconds/index.js"));
- var _index8 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
- var MINUTES_IN_DAY = 1440;
- var MINUTES_IN_ALMOST_TWO_DAYS = 2520;
- var MINUTES_IN_MONTH = 43200;
- var MINUTES_IN_TWO_MONTHS = 86400;
- /**
- * @name formatDistance
- * @category Common Helpers
- * @summary Return the distance between the given dates in words.
- *
- * @description
- * Return the distance between the given dates in words.
- *
- * | Distance between dates | Result |
- * |-------------------------------------------------------------------|---------------------|
- * | 0 ... 30 secs | less than a minute |
- * | 30 secs ... 1 min 30 secs | 1 minute |
- * | 1 min 30 secs ... 44 mins 30 secs | [2..44] minutes |
- * | 44 mins ... 30 secs ... 89 mins 30 secs | about 1 hour |
- * | 89 mins 30 secs ... 23 hrs 59 mins 30 secs | about [2..24] hours |
- * | 23 hrs 59 mins 30 secs ... 41 hrs 59 mins 30 secs | 1 day |
- * | 41 hrs 59 mins 30 secs ... 29 days 23 hrs 59 mins 30 secs | [2..30] days |
- * | 29 days 23 hrs 59 mins 30 secs ... 44 days 23 hrs 59 mins 30 secs | about 1 month |
- * | 44 days 23 hrs 59 mins 30 secs ... 59 days 23 hrs 59 mins 30 secs | about 2 months |
- * | 59 days 23 hrs 59 mins 30 secs ... 1 yr | [2..12] months |
- * | 1 yr ... 1 yr 3 months | about 1 year |
- * | 1 yr 3 months ... 1 yr 9 month s | over 1 year |
- * | 1 yr 9 months ... 2 yrs | almost 2 years |
- * | N yrs ... N yrs 3 months | about N years |
- * | N yrs 3 months ... N yrs 9 months | over N years |
- * | N yrs 9 months ... N+1 yrs | almost N+1 years |
- *
- * With `options.includeSeconds == true`:
- * | Distance between dates | Result |
- * |------------------------|----------------------|
- * | 0 secs ... 5 secs | less than 5 seconds |
- * | 5 secs ... 10 secs | less than 10 seconds |
- * | 10 secs ... 20 secs | less than 20 seconds |
- * | 20 secs ... 40 secs | half a minute |
- * | 40 secs ... 60 secs | less than a minute |
- * | 60 secs ... 90 secs | 1 minute |
- *
- * ### v2.0.0 breaking changes:
- *
- * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes).
- *
- * - The function was renamed from `distanceInWords ` to `formatDistance`
- * to make its name consistent with `format` and `formatRelative`.
- *
- * - The order of arguments is swapped to make the function
- * consistent with `differenceIn...` functions.
- *
- * ```javascript
- * // Before v2.0.0
- *
- * distanceInWords(
- * new Date(1986, 3, 4, 10, 32, 0),
- * new Date(1986, 3, 4, 11, 32, 0),
- * { addSuffix: true }
- * ) //=> 'in about 1 hour'
- *
- * // v2.0.0 onward
- *
- * formatDistance(
- * new Date(1986, 3, 4, 11, 32, 0),
- * new Date(1986, 3, 4, 10, 32, 0),
- * { addSuffix: true }
- * ) //=> 'in about 1 hour'
- * ```
- *
- * @param {Date|Number} date - the date
- * @param {Date|Number} baseDate - the date to compare with
- * @param {Object} [options] - an object with options.
- * @param {Boolean} [options.includeSeconds=false] - distances less than a minute are more detailed
- * @param {Boolean} [options.addSuffix=false] - result indicates if the second date is earlier or later than the first
- * @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale}
- * @returns {String} the distance in words
- * @throws {TypeError} 2 arguments required
- * @throws {RangeError} `date` must not be Invalid Date
- * @throws {RangeError} `baseDate` must not be Invalid Date
- * @throws {RangeError} `options.locale` must contain `formatDistance` property
- *
- * @example
- * // What is the distance between 2 July 2014 and 1 January 2015?
- * const result = formatDistance(new Date(2014, 6, 2), new Date(2015, 0, 1))
- * //=> '6 months'
- *
- * @example
- * // What is the distance between 1 January 2015 00:00:15
- * // and 1 January 2015 00:00:00, including seconds?
- * const result = formatDistance(
- * new Date(2015, 0, 1, 0, 0, 15),
- * new Date(2015, 0, 1, 0, 0, 0),
- * { includeSeconds: true }
- * )
- * //=> 'less than 20 seconds'
- *
- * @example
- * // What is the distance from 1 January 2016
- * // to 1 January 2015, with a suffix?
- * const result = formatDistance(new Date(2015, 0, 1), new Date(2016, 0, 1), {
- * addSuffix: true
- * })
- * //=> 'about 1 year ago'
- *
- * @example
- * // What is the distance between 1 August 2016 and 1 January 2015 in Esperanto?
- * import { eoLocale } from 'date-fns/locale/eo'
- * const result = formatDistance(new Date(2016, 7, 1), new Date(2015, 0, 1), {
- * locale: eoLocale
- * })
- * //=> 'pli ol 1 jaro'
- */
- function formatDistance(dirtyDate, dirtyBaseDate) {
- var options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
- (0, _index8.default)(2, arguments);
- var locale = options.locale || _index4.default;
- if (!locale.formatDistance) {
- throw new RangeError('locale must contain formatDistance property');
- }
- var comparison = (0, _index.default)(dirtyDate, dirtyBaseDate);
- if (isNaN(comparison)) {
- throw new RangeError('Invalid time value');
- }
- var localizeOptions = (0, _index6.default)(options);
- localizeOptions.addSuffix = Boolean(options.addSuffix);
- localizeOptions.comparison = comparison;
- var dateLeft;
- var dateRight;
- if (comparison > 0) {
- dateLeft = (0, _index5.default)(dirtyBaseDate);
- dateRight = (0, _index5.default)(dirtyDate);
- } else {
- dateLeft = (0, _index5.default)(dirtyDate);
- dateRight = (0, _index5.default)(dirtyBaseDate);
- }
- var seconds = (0, _index3.default)(dateRight, dateLeft);
- var offsetInSeconds = ((0, _index7.default)(dateRight) - (0, _index7.default)(dateLeft)) / 1000;
- var minutes = Math.round((seconds - offsetInSeconds) / 60);
- var months; // 0 up to 2 mins
- if (minutes < 2) {
- if (options.includeSeconds) {
- if (seconds < 5) {
- return locale.formatDistance('lessThanXSeconds', 5, localizeOptions);
- } else if (seconds < 10) {
- return locale.formatDistance('lessThanXSeconds', 10, localizeOptions);
- } else if (seconds < 20) {
- return locale.formatDistance('lessThanXSeconds', 20, localizeOptions);
- } else if (seconds < 40) {
- return locale.formatDistance('halfAMinute', null, localizeOptions);
- } else if (seconds < 60) {
- return locale.formatDistance('lessThanXMinutes', 1, localizeOptions);
- } else {
- return locale.formatDistance('xMinutes', 1, localizeOptions);
- }
- } else {
- if (minutes === 0) {
- return locale.formatDistance('lessThanXMinutes', 1, localizeOptions);
- } else {
- return locale.formatDistance('xMinutes', minutes, localizeOptions);
- }
- } // 2 mins up to 0.75 hrs
- } else if (minutes < 45) {
- return locale.formatDistance('xMinutes', minutes, localizeOptions); // 0.75 hrs up to 1.5 hrs
- } else if (minutes < 90) {
- return locale.formatDistance('aboutXHours', 1, localizeOptions); // 1.5 hrs up to 24 hrs
- } else if (minutes < MINUTES_IN_DAY) {
- var hours = Math.round(minutes / 60);
- return locale.formatDistance('aboutXHours', hours, localizeOptions); // 1 day up to 1.75 days
- } else if (minutes < MINUTES_IN_ALMOST_TWO_DAYS) {
- return locale.formatDistance('xDays', 1, localizeOptions); // 1.75 days up to 30 days
- } else if (minutes < MINUTES_IN_MONTH) {
- var days = Math.round(minutes / MINUTES_IN_DAY);
- return locale.formatDistance('xDays', days, localizeOptions); // 1 month up to 2 months
- } else if (minutes < MINUTES_IN_TWO_MONTHS) {
- months = Math.round(minutes / MINUTES_IN_MONTH);
- return locale.formatDistance('aboutXMonths', months, localizeOptions);
- }
- months = (0, _index2.default)(dateRight, dateLeft); // 2 months up to 12 months
- if (months < 12) {
- var nearestMonth = Math.round(minutes / MINUTES_IN_MONTH);
- return locale.formatDistance('xMonths', nearestMonth, localizeOptions); // 1 year up to max Date
- } else {
- var monthsSinceStartOfYear = months % 12;
- var years = Math.floor(months / 12); // N years up to 1 years 3 months
- if (monthsSinceStartOfYear < 3) {
- return locale.formatDistance('aboutXYears', years, localizeOptions); // N years 3 months up to N years 9 months
- } else if (monthsSinceStartOfYear < 9) {
- return locale.formatDistance('overXYears', years, localizeOptions); // N years 9 months up to N year 12 months
- } else {
- return locale.formatDistance('almostXYears', years + 1, localizeOptions);
- }
- }
- }
- module.exports = exports.default;
|