index.js 888 B

123456789101112131415161718192021222324252627282930
  1. import requiredArgs from "../_lib/requiredArgs/index.js";
  2. import { millisecondsInHour } from "../constants/index.js";
  3. /**
  4. * @name millisecondsToHours
  5. * @category Conversion Helpers
  6. * @summary Convert milliseconds to hours.
  7. *
  8. * @description
  9. * Convert a number of milliseconds to a full number of hours.
  10. *
  11. * @param {number} milliseconds - number of milliseconds to be converted
  12. *
  13. * @returns {number} the number of milliseconds converted in hours
  14. * @throws {TypeError} 1 argument required
  15. *
  16. * @example
  17. * // Convert 7200000 milliseconds to hours:
  18. * const result = millisecondsToHours(7200000)
  19. * //=> 2
  20. *
  21. * @example
  22. * // It uses floor rounding:
  23. * const result = millisecondsToHours(7199999)
  24. * //=> 1
  25. */
  26. export default function millisecondsToHours(milliseconds) {
  27. requiredArgs(1, arguments);
  28. var hours = milliseconds / millisecondsInHour;
  29. return Math.floor(hours);
  30. }