hoursToMilliseconds.js 644 B

12345678910111213141516171819202122232425
  1. import { millisecondsInHour } from "./constants.js";
  2. /**
  3. * @name hoursToMilliseconds
  4. * @category Conversion Helpers
  5. * @summary Convert hours to milliseconds.
  6. *
  7. * @description
  8. * Convert a number of hours to a full number of milliseconds.
  9. *
  10. * @param hours - number of hours to be converted
  11. *
  12. * @returns The number of hours converted to milliseconds
  13. *
  14. * @example
  15. * // Convert 2 hours to milliseconds:
  16. * const result = hoursToMilliseconds(2)
  17. * //=> 7200000
  18. */
  19. export function hoursToMilliseconds(hours) {
  20. return Math.trunc(hours * millisecondsInHour);
  21. }
  22. // Fallback for modularized imports:
  23. export default hoursToMilliseconds;