secondsToMilliseconds.js 661 B

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