Vlad Durnea
cffdf8af86
Some checks failed
CI/CD Pipeline / unit-tests (push) Failing after 1m16s
CI/CD Pipeline / integration-tests (push) Failing after 2m32s
CI/CD Pipeline / lint (push) Successful in 5m22s
CI/CD Pipeline / e2e-tests (push) Has been skipped
CI/CD Pipeline / build (push) Has been skipped
28 lines
829 B
JavaScript
28 lines
829 B
JavaScript
import { millisecondsInHour } from "./constants.mjs";
|
|
|
|
/**
|
|
* @name hoursToMilliseconds
|
|
* @category Conversion Helpers
|
|
* @summary Convert hours to milliseconds.
|
|
*
|
|
* @description
|
|
* Convert a number of hours to a full number of milliseconds.
|
|
*
|
|
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
|
|
*
|
|
* @param hours - number of hours to be converted
|
|
*
|
|
* @returns The number of hours converted to milliseconds
|
|
*
|
|
* @example
|
|
* // Convert 2 hours to milliseconds:
|
|
* const result = hoursToMilliseconds(2)
|
|
* //=> 7200000
|
|
*/
|
|
export function hoursToMilliseconds(hours) {
|
|
return Math.trunc(hours * millisecondsInHour);
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default hoursToMilliseconds;
|