110 lines
3.7 KiB
JavaScript
110 lines
3.7 KiB
JavaScript
"use strict";
|
|
|
|
Object.defineProperty(exports, "__esModule", {
|
|
value: true
|
|
});
|
|
exports.default = formatDuration;
|
|
|
|
var _index = require("../_lib/defaultOptions/index.js");
|
|
|
|
var _index2 = _interopRequireDefault(require("../_lib/defaultLocale/index.js"));
|
|
|
|
function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
|
|
|
|
var defaultFormat = ['years', 'months', 'weeks', 'days', 'hours', 'minutes', 'seconds'];
|
|
/**
|
|
* @name formatDuration
|
|
* @category Common Helpers
|
|
* @summary Formats a duration in human-readable format
|
|
*
|
|
* @description
|
|
* Return human-readable duration string i.e. "9 months 2 days"
|
|
*
|
|
* @param {Duration} duration - the duration to format
|
|
* @param {Object} [options] - an object with options.
|
|
* @param {string[]} [options.format=['years', 'months', 'weeks', 'days', 'hours', 'minutes', 'seconds']] - the array of units to format
|
|
* @param {boolean} [options.zero=false] - should zeros be included in the output?
|
|
* @param {string} [options.delimiter=' '] - delimiter string
|
|
* @param {Locale} [options.locale=defaultLocale] - the locale object. See [Locale]{@link https://date-fns.org/docs/Locale}
|
|
* @returns {string} the formatted date string
|
|
* @throws {TypeError} 1 argument required
|
|
*
|
|
* @example
|
|
* // Format full duration
|
|
* formatDuration({
|
|
* years: 2,
|
|
* months: 9,
|
|
* weeks: 1,
|
|
* days: 7,
|
|
* hours: 5,
|
|
* minutes: 9,
|
|
* seconds: 30
|
|
* })
|
|
* //=> '2 years 9 months 1 week 7 days 5 hours 9 minutes 30 seconds'
|
|
*
|
|
* @example
|
|
* // Format partial duration
|
|
* formatDuration({ months: 9, days: 2 })
|
|
* //=> '9 months 2 days'
|
|
*
|
|
* @example
|
|
* // Customize the format
|
|
* formatDuration(
|
|
* {
|
|
* years: 2,
|
|
* months: 9,
|
|
* weeks: 1,
|
|
* days: 7,
|
|
* hours: 5,
|
|
* minutes: 9,
|
|
* seconds: 30
|
|
* },
|
|
* { format: ['months', 'weeks'] }
|
|
* ) === '9 months 1 week'
|
|
*
|
|
* @example
|
|
* // Customize the zeros presence
|
|
* formatDuration({ years: 0, months: 9 })
|
|
* //=> '9 months'
|
|
* formatDuration({ years: 0, months: 9 }, { zero: true })
|
|
* //=> '0 years 9 months'
|
|
*
|
|
* @example
|
|
* // Customize the delimiter
|
|
* formatDuration({ years: 2, months: 9, weeks: 3 }, { delimiter: ', ' })
|
|
* //=> '2 years, 9 months, 3 weeks'
|
|
*/
|
|
|
|
function formatDuration(duration, options) {
|
|
var _ref, _options$locale, _options$format, _options$zero, _options$delimiter;
|
|
|
|
if (arguments.length < 1) {
|
|
throw new TypeError("1 argument required, but only ".concat(arguments.length, " present"));
|
|
}
|
|
|
|
var defaultOptions = (0, _index.getDefaultOptions)();
|
|
var locale = (_ref = (_options$locale = options === null || options === void 0 ? void 0 : options.locale) !== null && _options$locale !== void 0 ? _options$locale : defaultOptions.locale) !== null && _ref !== void 0 ? _ref : _index2.default;
|
|
var format = (_options$format = options === null || options === void 0 ? void 0 : options.format) !== null && _options$format !== void 0 ? _options$format : defaultFormat;
|
|
var zero = (_options$zero = options === null || options === void 0 ? void 0 : options.zero) !== null && _options$zero !== void 0 ? _options$zero : false;
|
|
var delimiter = (_options$delimiter = options === null || options === void 0 ? void 0 : options.delimiter) !== null && _options$delimiter !== void 0 ? _options$delimiter : ' ';
|
|
|
|
if (!locale.formatDistance) {
|
|
return '';
|
|
}
|
|
|
|
var result = format.reduce(function (acc, unit) {
|
|
var token = "x".concat(unit.replace(/(^.)/, function (m) {
|
|
return m.toUpperCase();
|
|
}));
|
|
var value = duration[unit];
|
|
|
|
if (typeof value === 'number' && (zero || duration[unit])) {
|
|
return acc.concat(locale.formatDistance(token, value));
|
|
}
|
|
|
|
return acc;
|
|
}, []).join(delimiter);
|
|
return result;
|
|
}
|
|
|
|
module.exports = exports.default; |