hugoWebsite/node_modules/date-fns/esm/secondsToMilliseconds/index.js

25 lines
744 B
JavaScript

import requiredArgs from "../_lib/requiredArgs/index.js";
import { millisecondsInSecond } from "../constants/index.js";
/**
* @name secondsToMilliseconds
* @category Conversion Helpers
* @summary Convert seconds to milliseconds.
*
* @description
* Convert a number of seconds to a full number of milliseconds.
*
* @param {number} seconds - number of seconds to be converted
*
* @returns {number} the number of seconds converted in milliseconds
* @throws {TypeError} 1 argument required
*
* @example
* // Convert 2 seconds into milliseconds
* const result = secondsToMilliseconds(2)
* //=> 2000
*/
export default function secondsToMilliseconds(seconds) {
requiredArgs(1, arguments);
return seconds * millisecondsInSecond;
}