index.js 902 B

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