index.js 1.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. import _typeof from "@babel/runtime/helpers/esm/typeof";
  2. import requiredArgs from "../_lib/requiredArgs/index.js";
  3. /**
  4. * @name formatISODuration
  5. * @category Common Helpers
  6. * @summary Format a duration object according as ISO 8601 duration string
  7. *
  8. * @description
  9. * Format a duration object according to the ISO 8601 duration standard (https://www.digi.com/resources/documentation/digidocs/90001437-13/reference/r_iso_8601_duration_format.htm)
  10. *
  11. * @param {Duration} duration - the duration to format
  12. *
  13. * @returns {String} The ISO 8601 duration string
  14. * @throws {TypeError} Requires 1 argument
  15. * @throws {Error} Argument must be an object
  16. *
  17. * @example
  18. * // Format the given duration as ISO 8601 string
  19. * const result = formatISODuration({
  20. * years: 39,
  21. * months: 2,
  22. * days: 20,
  23. * hours: 7,
  24. * minutes: 5,
  25. * seconds: 0
  26. * })
  27. * //=> 'P39Y2M20DT0H0M0S'
  28. */
  29. export default function formatISODuration(duration) {
  30. requiredArgs(1, arguments);
  31. if (_typeof(duration) !== 'object') throw new Error('Duration must be an object');
  32. var _duration$years = duration.years,
  33. years = _duration$years === void 0 ? 0 : _duration$years,
  34. _duration$months = duration.months,
  35. months = _duration$months === void 0 ? 0 : _duration$months,
  36. _duration$days = duration.days,
  37. days = _duration$days === void 0 ? 0 : _duration$days,
  38. _duration$hours = duration.hours,
  39. hours = _duration$hours === void 0 ? 0 : _duration$hours,
  40. _duration$minutes = duration.minutes,
  41. minutes = _duration$minutes === void 0 ? 0 : _duration$minutes,
  42. _duration$seconds = duration.seconds,
  43. seconds = _duration$seconds === void 0 ? 0 : _duration$seconds;
  44. return "P".concat(years, "Y").concat(months, "M").concat(days, "DT").concat(hours, "H").concat(minutes, "M").concat(seconds, "S");
  45. }