index.js 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100
  1. "use strict";
  2. var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
  3. Object.defineProperty(exports, "__esModule", {
  4. value: true
  5. });
  6. exports.default = formatDistanceToNow;
  7. var _index = _interopRequireDefault(require("../formatDistance/index.js"));
  8. var _index2 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
  9. /**
  10. * @name formatDistanceToNow
  11. * @category Common Helpers
  12. * @summary Return the distance between the given date and now in words.
  13. * @pure false
  14. *
  15. * @description
  16. * Return the distance between the given date and now in words.
  17. *
  18. * | Distance to now | Result |
  19. * |-------------------------------------------------------------------|---------------------|
  20. * | 0 ... 30 secs | less than a minute |
  21. * | 30 secs ... 1 min 30 secs | 1 minute |
  22. * | 1 min 30 secs ... 44 mins 30 secs | [2..44] minutes |
  23. * | 44 mins ... 30 secs ... 89 mins 30 secs | about 1 hour |
  24. * | 89 mins 30 secs ... 23 hrs 59 mins 30 secs | about [2..24] hours |
  25. * | 23 hrs 59 mins 30 secs ... 41 hrs 59 mins 30 secs | 1 day |
  26. * | 41 hrs 59 mins 30 secs ... 29 days 23 hrs 59 mins 30 secs | [2..30] days |
  27. * | 29 days 23 hrs 59 mins 30 secs ... 44 days 23 hrs 59 mins 30 secs | about 1 month |
  28. * | 44 days 23 hrs 59 mins 30 secs ... 59 days 23 hrs 59 mins 30 secs | about 2 months |
  29. * | 59 days 23 hrs 59 mins 30 secs ... 1 yr | [2..12] months |
  30. * | 1 yr ... 1 yr 3 months | about 1 year |
  31. * | 1 yr 3 months ... 1 yr 9 month s | over 1 year |
  32. * | 1 yr 9 months ... 2 yrs | almost 2 years |
  33. * | N yrs ... N yrs 3 months | about N years |
  34. * | N yrs 3 months ... N yrs 9 months | over N years |
  35. * | N yrs 9 months ... N+1 yrs | almost N+1 years |
  36. *
  37. * With `options.includeSeconds == true`:
  38. * | Distance to now | Result |
  39. * |---------------------|----------------------|
  40. * | 0 secs ... 5 secs | less than 5 seconds |
  41. * | 5 secs ... 10 secs | less than 10 seconds |
  42. * | 10 secs ... 20 secs | less than 20 seconds |
  43. * | 20 secs ... 40 secs | half a minute |
  44. * | 40 secs ... 60 secs | less than a minute |
  45. * | 60 secs ... 90 secs | 1 minute |
  46. *
  47. * > ⚠️ Please note that this function is not present in the FP submodule as
  48. * > it uses `Date.now()` internally hence impure and can't be safely curried.
  49. *
  50. * @param {Date|Number} date - the given date
  51. * @param {Object} [options] - the object with options
  52. * @param {Boolean} [options.includeSeconds=false] - distances less than a minute are more detailed
  53. * @param {Boolean} [options.addSuffix=false] - result specifies if now is earlier or later than the passed date
  54. * @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale}
  55. * @returns {String} the distance in words
  56. * @throws {TypeError} 1 argument required
  57. * @throws {RangeError} `date` must not be Invalid Date
  58. * @throws {RangeError} `options.locale` must contain `formatDistance` property
  59. *
  60. * @example
  61. * // If today is 1 January 2015, what is the distance to 2 July 2014?
  62. * const result = formatDistanceToNow(
  63. * new Date(2014, 6, 2)
  64. * )
  65. * //=> '6 months'
  66. *
  67. * @example
  68. * // If now is 1 January 2015 00:00:00,
  69. * // what is the distance to 1 January 2015 00:00:15, including seconds?
  70. * const result = formatDistanceToNow(
  71. * new Date(2015, 0, 1, 0, 0, 15),
  72. * {includeSeconds: true}
  73. * )
  74. * //=> 'less than 20 seconds'
  75. *
  76. * @example
  77. * // If today is 1 January 2015,
  78. * // what is the distance to 1 January 2016, with a suffix?
  79. * const result = formatDistanceToNow(
  80. * new Date(2016, 0, 1),
  81. * {addSuffix: true}
  82. * )
  83. * //=> 'in about 1 year'
  84. *
  85. * @example
  86. * // If today is 1 January 2015,
  87. * // what is the distance to 1 August 2016 in Esperanto?
  88. * const eoLocale = require('date-fns/locale/eo')
  89. * const result = formatDistanceToNow(
  90. * new Date(2016, 7, 1),
  91. * {locale: eoLocale}
  92. * )
  93. * //=> 'pli ol 1 jaro'
  94. */
  95. function formatDistanceToNow(dirtyDate, options) {
  96. (0, _index2.default)(1, arguments);
  97. return (0, _index.default)(dirtyDate, Date.now(), options);
  98. }
  99. module.exports = exports.default;