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