daysToWeeks.js 904 B

12345678910111213141516171819202122232425262728293031323334
  1. "use strict";
  2. exports.daysToWeeks = daysToWeeks;
  3. var _index = require("./constants.js");
  4. /**
  5. * @name daysToWeeks
  6. * @category Conversion Helpers
  7. * @summary Convert days to weeks.
  8. *
  9. * @description
  10. * Convert a number of days to a full number of weeks.
  11. *
  12. * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
  13. *
  14. * @param days - The number of days to be converted
  15. *
  16. * @returns The number of days converted in weeks
  17. *
  18. * @example
  19. * // Convert 14 days to weeks:
  20. * const result = daysToWeeks(14)
  21. * //=> 2
  22. *
  23. * @example
  24. * // It uses trunc rounding:
  25. * const result = daysToWeeks(13)
  26. * //=> 1
  27. */
  28. function daysToWeeks(days) {
  29. const weeks = days / _index.daysInWeek;
  30. const result = Math.trunc(weeks);
  31. // Prevent negative zero
  32. return result === 0 ? 0 : result;
  33. }