index.js 743 B

123456789101112131415161718192021222324
  1. import requiredArgs from "../_lib/requiredArgs/index.js";
  2. import { millisecondsInSecond } from "../constants/index.js";
  3. /**
  4. * @name secondsToMilliseconds
  5. * @category Conversion Helpers
  6. * @summary Convert seconds to milliseconds.
  7. *
  8. * @description
  9. * Convert a number of seconds to a full number of milliseconds.
  10. *
  11. * @param {number} seconds - number of seconds to be converted
  12. *
  13. * @returns {number} the number of seconds converted in milliseconds
  14. * @throws {TypeError} 1 argument required
  15. *
  16. * @example
  17. * // Convert 2 seconds into milliseconds
  18. * const result = secondsToMilliseconds(2)
  19. * //=> 2000
  20. */
  21. export default function secondsToMilliseconds(seconds) {
  22. requiredArgs(1, arguments);
  23. return seconds * millisecondsInSecond;
  24. }