timepiece/node_modules/date-fns/getQuarter.d.mts

23 lines
635 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name getQuarter
* @category Quarter Helpers
* @summary Get the year quarter of the given date.
*
* @description
* Get the year quarter of the given date.
*
* @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 date - The given date
*
* @returns The quarter
*
* @example
* // Which quarter is 2 July 2014?
* const result = getQuarter(new Date(2014, 6, 2))
* //=> 3
*/
export declare function getQuarter<DateType extends Date>(
date: DateType | number | string,
): number;