formatDistance.cjs 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199
  1. "use strict";
  2. exports.formatDistance = formatDistance;
  3. var _index = require("./_lib/defaultLocale.cjs");
  4. var _index2 = require("./_lib/defaultOptions.cjs");
  5. var _index3 = require("./_lib/getTimezoneOffsetInMilliseconds.cjs");
  6. var _index4 = require("./_lib/normalizeDates.cjs");
  7. var _index5 = require("./compareAsc.cjs");
  8. var _index6 = require("./constants.cjs");
  9. var _index7 = require("./differenceInMonths.cjs");
  10. var _index8 = require("./differenceInSeconds.cjs");
  11. /**
  12. * The {@link formatDistance} function options.
  13. */
  14. /**
  15. * @name formatDistance
  16. * @category Common Helpers
  17. * @summary Return the distance between the given dates in words.
  18. *
  19. * @description
  20. * Return the distance between the given dates in words.
  21. *
  22. * | Distance between dates | Result |
  23. * |-------------------------------------------------------------------|---------------------|
  24. * | 0 ... 30 secs | less than a minute |
  25. * | 30 secs ... 1 min 30 secs | 1 minute |
  26. * | 1 min 30 secs ... 44 mins 30 secs | [2..44] minutes |
  27. * | 44 mins ... 30 secs ... 89 mins 30 secs | about 1 hour |
  28. * | 89 mins 30 secs ... 23 hrs 59 mins 30 secs | about [2..24] hours |
  29. * | 23 hrs 59 mins 30 secs ... 41 hrs 59 mins 30 secs | 1 day |
  30. * | 41 hrs 59 mins 30 secs ... 29 days 23 hrs 59 mins 30 secs | [2..30] days |
  31. * | 29 days 23 hrs 59 mins 30 secs ... 44 days 23 hrs 59 mins 30 secs | about 1 month |
  32. * | 44 days 23 hrs 59 mins 30 secs ... 59 days 23 hrs 59 mins 30 secs | about 2 months |
  33. * | 59 days 23 hrs 59 mins 30 secs ... 1 yr | [2..12] months |
  34. * | 1 yr ... 1 yr 3 months | about 1 year |
  35. * | 1 yr 3 months ... 1 yr 9 month s | over 1 year |
  36. * | 1 yr 9 months ... 2 yrs | almost 2 years |
  37. * | N yrs ... N yrs 3 months | about N years |
  38. * | N yrs 3 months ... N yrs 9 months | over N years |
  39. * | N yrs 9 months ... N+1 yrs | almost N+1 years |
  40. *
  41. * With `options.includeSeconds == true`:
  42. * | Distance between dates | Result |
  43. * |------------------------|----------------------|
  44. * | 0 secs ... 5 secs | less than 5 seconds |
  45. * | 5 secs ... 10 secs | less than 10 seconds |
  46. * | 10 secs ... 20 secs | less than 20 seconds |
  47. * | 20 secs ... 40 secs | half a minute |
  48. * | 40 secs ... 60 secs | less than a minute |
  49. * | 60 secs ... 90 secs | 1 minute |
  50. *
  51. * @param laterDate - The date
  52. * @param earlierDate - The date to compare with
  53. * @param options - An object with options
  54. *
  55. * @returns The distance in words
  56. *
  57. * @throws `date` must not be Invalid Date
  58. * @throws `baseDate` must not be Invalid Date
  59. * @throws `options.locale` must contain `formatDistance` property
  60. *
  61. * @example
  62. * // What is the distance between 2 July 2014 and 1 January 2015?
  63. * const result = formatDistance(new Date(2014, 6, 2), new Date(2015, 0, 1))
  64. * //=> '6 months'
  65. *
  66. * @example
  67. * // What is the distance between 1 January 2015 00:00:15
  68. * // and 1 January 2015 00:00:00, including seconds?
  69. * const result = formatDistance(
  70. * new Date(2015, 0, 1, 0, 0, 15),
  71. * new Date(2015, 0, 1, 0, 0, 0),
  72. * { includeSeconds: true }
  73. * )
  74. * //=> 'less than 20 seconds'
  75. *
  76. * @example
  77. * // What is the distance from 1 January 2016
  78. * // to 1 January 2015, with a suffix?
  79. * const result = formatDistance(new Date(2015, 0, 1), new Date(2016, 0, 1), {
  80. * addSuffix: true
  81. * })
  82. * //=> 'about 1 year ago'
  83. *
  84. * @example
  85. * // What is the distance between 1 August 2016 and 1 January 2015 in Esperanto?
  86. * import { eoLocale } from 'date-fns/locale/eo'
  87. * const result = formatDistance(new Date(2016, 7, 1), new Date(2015, 0, 1), {
  88. * locale: eoLocale
  89. * })
  90. * //=> 'pli ol 1 jaro'
  91. */
  92. function formatDistance(laterDate, earlierDate, options) {
  93. const defaultOptions = (0, _index2.getDefaultOptions)();
  94. const locale =
  95. options?.locale ?? defaultOptions.locale ?? _index.defaultLocale;
  96. const minutesInAlmostTwoDays = 2520;
  97. const comparison = (0, _index5.compareAsc)(laterDate, earlierDate);
  98. if (isNaN(comparison)) throw new RangeError("Invalid time value");
  99. const localizeOptions = Object.assign({}, options, {
  100. addSuffix: options?.addSuffix,
  101. comparison: comparison,
  102. });
  103. const [laterDate_, earlierDate_] = (0, _index4.normalizeDates)(
  104. options?.in,
  105. ...(comparison > 0 ? [earlierDate, laterDate] : [laterDate, earlierDate]),
  106. );
  107. const seconds = (0, _index8.differenceInSeconds)(earlierDate_, laterDate_);
  108. const offsetInSeconds =
  109. ((0, _index3.getTimezoneOffsetInMilliseconds)(earlierDate_) -
  110. (0, _index3.getTimezoneOffsetInMilliseconds)(laterDate_)) /
  111. 1000;
  112. const minutes = Math.round((seconds - offsetInSeconds) / 60);
  113. let months;
  114. // 0 up to 2 mins
  115. if (minutes < 2) {
  116. if (options?.includeSeconds) {
  117. if (seconds < 5) {
  118. return locale.formatDistance("lessThanXSeconds", 5, localizeOptions);
  119. } else if (seconds < 10) {
  120. return locale.formatDistance("lessThanXSeconds", 10, localizeOptions);
  121. } else if (seconds < 20) {
  122. return locale.formatDistance("lessThanXSeconds", 20, localizeOptions);
  123. } else if (seconds < 40) {
  124. return locale.formatDistance("halfAMinute", 0, localizeOptions);
  125. } else if (seconds < 60) {
  126. return locale.formatDistance("lessThanXMinutes", 1, localizeOptions);
  127. } else {
  128. return locale.formatDistance("xMinutes", 1, localizeOptions);
  129. }
  130. } else {
  131. if (minutes === 0) {
  132. return locale.formatDistance("lessThanXMinutes", 1, localizeOptions);
  133. } else {
  134. return locale.formatDistance("xMinutes", minutes, localizeOptions);
  135. }
  136. }
  137. // 2 mins up to 0.75 hrs
  138. } else if (minutes < 45) {
  139. return locale.formatDistance("xMinutes", minutes, localizeOptions);
  140. // 0.75 hrs up to 1.5 hrs
  141. } else if (minutes < 90) {
  142. return locale.formatDistance("aboutXHours", 1, localizeOptions);
  143. // 1.5 hrs up to 24 hrs
  144. } else if (minutes < _index6.minutesInDay) {
  145. const hours = Math.round(minutes / 60);
  146. return locale.formatDistance("aboutXHours", hours, localizeOptions);
  147. // 1 day up to 1.75 days
  148. } else if (minutes < minutesInAlmostTwoDays) {
  149. return locale.formatDistance("xDays", 1, localizeOptions);
  150. // 1.75 days up to 30 days
  151. } else if (minutes < _index6.minutesInMonth) {
  152. const days = Math.round(minutes / _index6.minutesInDay);
  153. return locale.formatDistance("xDays", days, localizeOptions);
  154. // 1 month up to 2 months
  155. } else if (minutes < _index6.minutesInMonth * 2) {
  156. months = Math.round(minutes / _index6.minutesInMonth);
  157. return locale.formatDistance("aboutXMonths", months, localizeOptions);
  158. }
  159. months = (0, _index7.differenceInMonths)(earlierDate_, laterDate_);
  160. // 2 months up to 12 months
  161. if (months < 12) {
  162. const nearestMonth = Math.round(minutes / _index6.minutesInMonth);
  163. return locale.formatDistance("xMonths", nearestMonth, localizeOptions);
  164. // 1 year up to max Date
  165. } else {
  166. const monthsSinceStartOfYear = months % 12;
  167. const years = Math.trunc(months / 12);
  168. // N years up to 1 years 3 months
  169. if (monthsSinceStartOfYear < 3) {
  170. return locale.formatDistance("aboutXYears", years, localizeOptions);
  171. // N years 3 months up to N years 9 months
  172. } else if (monthsSinceStartOfYear < 9) {
  173. return locale.formatDistance("overXYears", years, localizeOptions);
  174. // N years 9 months up to N year 12 months
  175. } else {
  176. return locale.formatDistance("almostXYears", years + 1, localizeOptions);
  177. }
  178. }
  179. }