27 lines
756 B
JavaScript
27 lines
756 B
JavaScript
"use strict";
|
|
exports.hoursToSeconds = hoursToSeconds;
|
|
var _index = require("./constants.js");
|
|
|
|
/**
|
|
* @name hoursToSeconds
|
|
* @category Conversion Helpers
|
|
* @summary Convert hours to seconds.
|
|
*
|
|
* @description
|
|
* Convert a number of hours to a full number of seconds.
|
|
*
|
|
* @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 - The number of hours to be converted
|
|
*
|
|
* @returns The number of hours converted in seconds
|
|
*
|
|
* @example
|
|
* // Convert 2 hours to seconds:
|
|
* const result = hoursToSeconds(2)
|
|
* //=> 7200
|
|
*/
|
|
function hoursToSeconds(hours) {
|
|
return Math.trunc(hours * _index.secondsInHour);
|
|
}
|