millisecondsToSeconds.js 823 B

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