formatDistanceToNow.cjs 3.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. "use strict";
  2. exports.formatDistanceToNow = formatDistanceToNow;
  3. var _index = require("./constructNow.cjs");
  4. var _index2 = require("./formatDistance.cjs");
  5. /**
  6. * The {@link formatDistanceToNow} function options.
  7. */
  8. /**
  9. * @name formatDistanceToNow
  10. * @category Common Helpers
  11. * @summary Return the distance between the given date and now in words.
  12. * @pure false
  13. *
  14. * @description
  15. * Return the distance between the given date and now in words.
  16. *
  17. * | Distance to now | Result |
  18. * |-------------------------------------------------------------------|---------------------|
  19. * | 0 ... 30 secs | less than a minute |
  20. * | 30 secs ... 1 min 30 secs | 1 minute |
  21. * | 1 min 30 secs ... 44 mins 30 secs | [2..44] minutes |
  22. * | 44 mins ... 30 secs ... 89 mins 30 secs | about 1 hour |
  23. * | 89 mins 30 secs ... 23 hrs 59 mins 30 secs | about [2..24] hours |
  24. * | 23 hrs 59 mins 30 secs ... 41 hrs 59 mins 30 secs | 1 day |
  25. * | 41 hrs 59 mins 30 secs ... 29 days 23 hrs 59 mins 30 secs | [2..30] days |
  26. * | 29 days 23 hrs 59 mins 30 secs ... 44 days 23 hrs 59 mins 30 secs | about 1 month |
  27. * | 44 days 23 hrs 59 mins 30 secs ... 59 days 23 hrs 59 mins 30 secs | about 2 months |
  28. * | 59 days 23 hrs 59 mins 30 secs ... 1 yr | [2..12] months |
  29. * | 1 yr ... 1 yr 3 months | about 1 year |
  30. * | 1 yr 3 months ... 1 yr 9 month s | over 1 year |
  31. * | 1 yr 9 months ... 2 yrs | almost 2 years |
  32. * | N yrs ... N yrs 3 months | about N years |
  33. * | N yrs 3 months ... N yrs 9 months | over N years |
  34. * | N yrs 9 months ... N+1 yrs | almost N+1 years |
  35. *
  36. * With `options.includeSeconds == true`:
  37. * | Distance to now | Result |
  38. * |---------------------|----------------------|
  39. * | 0 secs ... 5 secs | less than 5 seconds |
  40. * | 5 secs ... 10 secs | less than 10 seconds |
  41. * | 10 secs ... 20 secs | less than 20 seconds |
  42. * | 20 secs ... 40 secs | half a minute |
  43. * | 40 secs ... 60 secs | less than a minute |
  44. * | 60 secs ... 90 secs | 1 minute |
  45. *
  46. * @param date - The given date
  47. * @param options - The object with options
  48. *
  49. * @returns The distance in words
  50. *
  51. * @throws `date` must not be Invalid Date
  52. * @throws `options.locale` must contain `formatDistance` property
  53. *
  54. * @example
  55. * // If today is 1 January 2015, what is the distance to 2 July 2014?
  56. * const result = formatDistanceToNow(
  57. * new Date(2014, 6, 2)
  58. * )
  59. * //=> '6 months'
  60. *
  61. * @example
  62. * // If now is 1 January 2015 00:00:00,
  63. * // what is the distance to 1 January 2015 00:00:15, including seconds?
  64. * const result = formatDistanceToNow(
  65. * new Date(2015, 0, 1, 0, 0, 15),
  66. * {includeSeconds: true}
  67. * )
  68. * //=> 'less than 20 seconds'
  69. *
  70. * @example
  71. * // If today is 1 January 2015,
  72. * // what is the distance to 1 January 2016, with a suffix?
  73. * const result = formatDistanceToNow(
  74. * new Date(2016, 0, 1),
  75. * {addSuffix: true}
  76. * )
  77. * //=> 'in about 1 year'
  78. *
  79. * @example
  80. * // If today is 1 January 2015,
  81. * // what is the distance to 1 August 2016 in Esperanto?
  82. * const eoLocale = require('date-fns/locale/eo')
  83. * const result = formatDistanceToNow(
  84. * new Date(2016, 7, 1),
  85. * {locale: eoLocale}
  86. * )
  87. * //=> 'pli ol 1 jaro'
  88. */
  89. function formatDistanceToNow(date, options) {
  90. return (0, _index2.formatDistance)(
  91. date,
  92. (0, _index.constructNow)(date),
  93. options,
  94. );
  95. }