timepiece/node_modules/date-fns/quartersToMonths.mjs

28 lines
817 B
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { monthsInQuarter } from "./constants.mjs";
/**
* @name quartersToMonths
* @category Conversion Helpers
* @summary Convert number of quarters to months.
*
* @description
* Convert a number of quarters to a full number of months.
*
* @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 quarters - The number of quarters to be converted
*
* @returns The number of quarters converted in months
*
* @example
* // Convert 2 quarters to months
* const result = quartersToMonths(2)
* //=> 6
*/
export function quartersToMonths(quarters) {
return Math.trunc(quarters * monthsInQuarter);
}
// Fallback for modularized imports:
export default quartersToMonths;