32 lines
807 B
JavaScript
32 lines
807 B
JavaScript
|
import { millisecondsInHour } from "./constants.mjs";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name millisecondsToHours
|
||
|
|
* @category Conversion Helpers
|
||
|
|
* @summary Convert milliseconds to hours.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Convert a number of milliseconds to a full number of hours.
|
||
|
|
*
|
||
|
|
* @param milliseconds - The number of milliseconds to be converted
|
||
|
|
*
|
||
|
|
* @returns The number of milliseconds converted in hours
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Convert 7200000 milliseconds to hours:
|
||
|
|
* const result = millisecondsToHours(7200000)
|
||
|
|
* //=> 2
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // It uses floor rounding:
|
||
|
|
* const result = millisecondsToHours(7199999)
|
||
|
|
* //=> 1
|
||
|
|
*/
|
||
|
|
export function millisecondsToHours(milliseconds) {
|
||
|
|
const hours = milliseconds / millisecondsInHour;
|
||
|
|
return Math.trunc(hours);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default millisecondsToHours;
|