millisecondsToMinutes.js 827 B

12345678910111213141516171819202122232425262728293031
  1. import { millisecondsInMinute } from "./constants.js";
  2. /**
  3. * @name millisecondsToMinutes
  4. * @category Conversion Helpers
  5. * @summary Convert milliseconds to minutes.
  6. *
  7. * @description
  8. * Convert a number of milliseconds to a full number of minutes.
  9. *
  10. * @param milliseconds - The number of milliseconds to be converted
  11. *
  12. * @returns The number of milliseconds converted in minutes
  13. *
  14. * @example
  15. * // Convert 60000 milliseconds to minutes:
  16. * const result = millisecondsToMinutes(60000)
  17. * //=> 1
  18. *
  19. * @example
  20. * // It uses floor rounding:
  21. * const result = millisecondsToMinutes(119999)
  22. * //=> 1
  23. */
  24. export function millisecondsToMinutes(milliseconds) {
  25. const minutes = milliseconds / millisecondsInMinute;
  26. return Math.trunc(minutes);
  27. }
  28. // Fallback for modularized imports:
  29. export default millisecondsToMinutes;