1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
|
"use strict";
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault").default;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = intlFormatDistance;
var _index = require("../constants/index.js");
var _index2 = _interopRequireDefault(require("../differenceInCalendarDays/index.js"));
var _index3 = _interopRequireDefault(require("../differenceInCalendarMonths/index.js"));
var _index4 = _interopRequireDefault(require("../differenceInCalendarQuarters/index.js"));
var _index5 = _interopRequireDefault(require("../differenceInCalendarWeeks/index.js"));
var _index6 = _interopRequireDefault(require("../differenceInCalendarYears/index.js"));
var _index7 = _interopRequireDefault(require("../differenceInHours/index.js"));
var _index8 = _interopRequireDefault(require("../differenceInMinutes/index.js"));
var _index9 = _interopRequireDefault(require("../differenceInSeconds/index.js"));
var _index10 = _interopRequireDefault(require("../toDate/index.js"));
var _index11 = _interopRequireDefault(require("../_lib/requiredArgs/index.js"));
/**
* @name intlFormatDistance
* @category Common Helpers
* @summary Formats distance between two dates in a human-readable format
* @description
* The function calculates the difference between two dates and formats it as a human-readable string.
*
* The function will pick the most appropriate unit depending on the distance between dates. For example, if the distance is a few hours, it might return `x hours`. If the distance is a few months, it might return `x months`.
*
* You can also specify a unit to force using it regardless of the distance to get a result like `123456 hours`.
*
* See the table below for the unit picking logic:
*
* | Distance between dates | Result (past) | Result (future) |
* | ---------------------- | -------------- | --------------- |
* | 0 seconds | now | now |
* | 1-59 seconds | X seconds ago | in X seconds |
* | 1-59 minutes | X minutes ago | in X minutes |
* | 1-23 hours | X hours ago | in X hours |
* | 1 day | yesterday | tomorrow |
* | 2-6 days | X days ago | in X days |
* | 7 days | last week | next week |
* | 8 days-1 month | X weeks ago | in X weeks |
* | 1 month | last month | next month |
* | 2-3 months | X months ago | in X months |
* | 1 quarter | last quarter | next quarter |
* | 2-3 quarters | X quarters ago | in X quarters |
* | 1 year | last year | next year |
* | 2+ years | X years ago | in X years |
*
* @param {Date|Number} date - the date
* @param {Date|Number} baseDate - the date to compare with.
* @param {Object} [options] - an object with options.
* @param {String} [options.unit] - formats the distance with the given unit ('year', 'quarter', 'month', 'week', 'day', 'hour', 'minute', 'second').
* @param {String|String[]} [options.locale] - the locale to use.
* @param {String} [options.localeMatcher='best fit'] - the locale matching algorithm to use. Other value: 'lookup'.
* See MDN for details [Locale identification and negotiation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl#locale_identification_and_negotiation)
* @param {String} [options.numeric='auto'] - the output message format. The values are 'auto' (e.g. `yesterday`), 'always'(e.g. `1 day ago`).
* @param {String} [options.style='long'] - the length of the result. The values are: 'long' (e.g. `1 month`), 'short' (e.g. 'in 1 mo.'), 'narrow' (e.g. 'in 1 mo.').
* The narrow one could be similar to the short one for some locales.
* @returns {String} the distance in words according to language-sensitive relative time formatting.
* @throws {TypeError} 2 arguments required
* @throws {RangeError} `date` must not be Invalid Date
* @throws {RangeError} `baseDate` must not be Invalid Date
* @throws {RangeError} `options.unit` must not be invalid Unit
* @throws {RangeError} `options.locale` must not be invalid locale
* @throws {RangeError} `options.localeMatcher` must not be invalid localeMatcher
* @throws {RangeError} `options.numeric` must not be invalid numeric
* @throws {RangeError} `options.style` must not be invalid style
*
* @example
* // What is the distance between the dates when the fist date is after the second?
* intlFormatDistance(
* new Date(1986, 3, 4, 11, 30, 0),
* new Date(1986, 3, 4, 10, 30, 0)
* )
* //=> 'in 1 hour'
*
* // What is the distance between the dates when the fist date is before the second?
* intlFormatDistance(
* new Date(1986, 3, 4, 10, 30, 0),
* new Date(1986, 3, 4, 11, 30, 0)
* )
* //=> '1 hour ago'
*
* @example
* // Use the unit option to force the function to output the result in quarters. Without setting it, the example would return "next year"
* intlFormatDistance(
* new Date(1987, 6, 4, 10, 30, 0),
* new Date(1986, 3, 4, 10, 30, 0),
* { unit: 'quarter' }
* )
* //=> 'in 5 quarters'
*
* @example
* // Use the locale option to get the result in Spanish. Without setting it, the example would return "in 1 hour".
* intlFormatDistance(
* new Date(1986, 3, 4, 11, 30, 0),
* new Date(1986, 3, 4, 10, 30, 0),
* { locale: 'es' }
* )
* //=> 'dentro de 1 hora'
*
* @example
* // Use the numeric option to force the function to use numeric values. Without setting it, the example would return "tomorrow".
* intlFormatDistance(
* new Date(1986, 3, 5, 11, 30, 0),
* new Date(1986, 3, 4, 11, 30, 0),
* { numeric: 'always' }
* )
* //=> 'in 1 day'
*
* @example
* // Use the style option to force the function to use short values. Without setting it, the example would return "in 2 years".
* intlFormatDistance(
* new Date(1988, 3, 4, 11, 30, 0),
* new Date(1986, 3, 4, 11, 30, 0),
* { style: 'short' }
* )
* //=> 'in 2 yr'
*/
function intlFormatDistance(date, baseDate, options) {
(0, _index11.default)(2, arguments);
var value = 0;
var unit;
var dateLeft = (0, _index10.default)(date);
var dateRight = (0, _index10.default)(baseDate);
if (!(options !== null && options !== void 0 && options.unit)) {
// Get the unit based on diffInSeconds calculations if no unit is specified
var diffInSeconds = (0, _index9.default)(dateLeft, dateRight); // The smallest unit
if (Math.abs(diffInSeconds) < _index.secondsInMinute) {
value = (0, _index9.default)(dateLeft, dateRight);
unit = 'second';
} else if (Math.abs(diffInSeconds) < _index.secondsInHour) {
value = (0, _index8.default)(dateLeft, dateRight);
unit = 'minute';
} else if (Math.abs(diffInSeconds) < _index.secondsInDay && Math.abs((0, _index2.default)(dateLeft, dateRight)) < 1) {
value = (0, _index7.default)(dateLeft, dateRight);
unit = 'hour';
} else if (Math.abs(diffInSeconds) < _index.secondsInWeek && (value = (0, _index2.default)(dateLeft, dateRight)) && Math.abs(value) < 7) {
unit = 'day';
} else if (Math.abs(diffInSeconds) < _index.secondsInMonth) {
value = (0, _index5.default)(dateLeft, dateRight);
unit = 'week';
} else if (Math.abs(diffInSeconds) < _index.secondsInQuarter) {
value = (0, _index3.default)(dateLeft, dateRight);
unit = 'month';
} else if (Math.abs(diffInSeconds) < _index.secondsInYear) {
if ((0, _index4.default)(dateLeft, dateRight) < 4) {
// To filter out cases that are less than a year but match 4 quarters
value = (0, _index4.default)(dateLeft, dateRight);
unit = 'quarter';
} else {
value = (0, _index6.default)(dateLeft, dateRight);
unit = 'year';
}
} else {
value = (0, _index6.default)(dateLeft, dateRight);
unit = 'year';
}
} else {
// Get the value if unit is specified
unit = options === null || options === void 0 ? void 0 : options.unit;
if (unit === 'second') {
value = (0, _index9.default)(dateLeft, dateRight);
} else if (unit === 'minute') {
value = (0, _index8.default)(dateLeft, dateRight);
} else if (unit === 'hour') {
value = (0, _index7.default)(dateLeft, dateRight);
} else if (unit === 'day') {
value = (0, _index2.default)(dateLeft, dateRight);
} else if (unit === 'week') {
value = (0, _index5.default)(dateLeft, dateRight);
} else if (unit === 'month') {
value = (0, _index3.default)(dateLeft, dateRight);
} else if (unit === 'quarter') {
value = (0, _index4.default)(dateLeft, dateRight);
} else if (unit === 'year') {
value = (0, _index6.default)(dateLeft, dateRight);
}
}
var rtf = new Intl.RelativeTimeFormat(options === null || options === void 0 ? void 0 : options.locale, {
localeMatcher: options === null || options === void 0 ? void 0 : options.localeMatcher,
numeric: (options === null || options === void 0 ? void 0 : options.numeric) || 'auto',
style: options === null || options === void 0 ? void 0 : options.style
});
return rtf.format(value, unit);
}
module.exports = exports.default;
|
