blob: 5d2443a0cd273c45a00f181de56d5fa14971b43d (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
import requiredArgs from "../_lib/requiredArgs/index.js";
import { millisecondsInHour } from "../constants/index.js";
/**
* @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) {
requiredArgs(1, arguments);
return Math.floor(hours * millisecondsInHour);
}
|