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