31 lines
889 B
JavaScript
31 lines
889 B
JavaScript
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
||
|
|
import { millisecondsInHour } from "../constants/index.js";
|
||
|
|
/**
|
||
|
|
* @name millisecondsToHours
|
||
|
|
* @category Conversion Helpers
|
||
|
|
* @summary Convert milliseconds to hours.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Convert a number of milliseconds to a full number of hours.
|
||
|
|
*
|
||
|
|
* @param {number} milliseconds - number of milliseconds to be converted
|
||
|
|
*
|
||
|
|
* @returns {number} the number of milliseconds converted in hours
|
||
|
|
* @throws {TypeError} 1 argument required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Convert 7200000 milliseconds to hours:
|
||
|
|
* const result = millisecondsToHours(7200000)
|
||
|
|
* //=> 2
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // It uses floor rounding:
|
||
|
|
* const result = millisecondsToHours(7199999)
|
||
|
|
* //=> 1
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function millisecondsToHours(milliseconds) {
|
||
|
|
requiredArgs(1, arguments);
|
||
|
|
var hours = milliseconds / millisecondsInHour;
|
||
|
|
return Math.floor(hours);
|
||
|
|
}
|