123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596 |
- "use strict";
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.default = formatDuration;
- var _index = _interopRequireDefault(require("../locale/en-US/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 be 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) {
- if (arguments.length < 1) {
- throw new TypeError("1 argument required, but only ".concat(arguments.length, " present"));
- }
- var format = (options === null || options === void 0 ? void 0 : options.format) || defaultFormat;
- var locale = (options === null || options === void 0 ? void 0 : options.locale) || _index.default;
- var zero = (options === null || options === void 0 ? void 0 : options.zero) || false;
- var delimiter = (options === null || options === void 0 ? void 0 : options.delimiter) || ' ';
- var result = format.reduce(function (acc, unit) {
- var token = "x".concat(unit.replace(/(^.)/, function (m) {
- return m.toUpperCase();
- }));
- var addChunk = typeof duration[unit] === 'number' && (zero || duration[unit]);
- return addChunk ? acc.concat(locale.formatDistance(token, duration[unit])) : acc;
- }, []).join(delimiter);
- return result;
- }
- module.exports = exports.default;
|