diff options
author | Sebastian <sebasjm@gmail.com> | 2021-08-23 16:46:06 -0300 |
---|---|---|
committer | Sebastian <sebasjm@gmail.com> | 2021-08-23 16:48:30 -0300 |
commit | 38acabfa6089ab8ac469c12b5f55022fb96935e5 (patch) | |
tree | 453dbf70000cc5e338b06201af1eaca8343f8f73 /date-fns/src/secondsToMilliseconds/index.ts | |
parent | f26125e039143b92dc0d84e7775f508ab0cdcaa8 (diff) | |
download | node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.tar.gz node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.tar.bz2 node-vendor-38acabfa6089ab8ac469c12b5f55022fb96935e5.zip |
Diffstat (limited to 'date-fns/src/secondsToMilliseconds/index.ts')
-rw-r--r-- | date-fns/src/secondsToMilliseconds/index.ts | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/date-fns/src/secondsToMilliseconds/index.ts b/date-fns/src/secondsToMilliseconds/index.ts new file mode 100644 index 0000000..2e4a663 --- /dev/null +++ b/date-fns/src/secondsToMilliseconds/index.ts @@ -0,0 +1,25 @@ +import requiredArgs from '../_lib/requiredArgs/index' +import { millisecondsInSecond } from '../constants/index' + +/** + * @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: number): number { + requiredArgs(1, arguments) + return seconds * millisecondsInSecond +} |