diff options
Diffstat (limited to 'date-fns/src/hoursToMilliseconds/index.ts')
-rw-r--r-- | date-fns/src/hoursToMilliseconds/index.ts | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/date-fns/src/hoursToMilliseconds/index.ts b/date-fns/src/hoursToMilliseconds/index.ts new file mode 100644 index 0000000..e87c7a3 --- /dev/null +++ b/date-fns/src/hoursToMilliseconds/index.ts @@ -0,0 +1,25 @@ +import requiredArgs from '../_lib/requiredArgs/index' +import { millisecondsInHour } from '../constants/index' + +/** + * @name hoursToMilliseconds + * @category Conversion Helpers + * @summary Convert hours to milliseconds. + * + * @description + * Convert a number of hours to a full number of milliseconds. + * + * @param {number} hours - number of hours to be converted + * + * @returns {number} the number of hours converted to milliseconds + * @throws {TypeError} 1 argument required + * + * @example + * // Convert 2 hours to milliseconds: + * const result = hoursToMilliseconds(2) + * //=> 7200000 + */ +export default function hoursToMilliseconds(hours: number): number { + requiredArgs(1, arguments) + return Math.floor(hours * millisecondsInHour) +} |