26 lines
752 B
TypeScript
26 lines
752 B
TypeScript
|
/**
|
||
|
|
* @name quartersToYears
|
||
|
|
* @category Conversion Helpers
|
||
|
|
* @summary Convert number of quarters to years.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Convert a number of quarters to a full number of years.
|
||
|
|
*
|
||
|
|
* @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 years
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Convert 8 quarters to years
|
||
|
|
* const result = quartersToYears(8)
|
||
|
|
* //=> 2
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // It uses floor rounding:
|
||
|
|
* const result = quartersToYears(11)
|
||
|
|
* //=> 2
|
||
|
|
*/
|
||
|
|
export declare function quartersToYears(quarters: number): number;
|