30 lines
1.0 KiB
TypeScript
30 lines
1.0 KiB
TypeScript
|
/**
|
||
|
|
* @name isSameQuarter
|
||
|
|
* @category Quarter Helpers
|
||
|
|
* @summary Are the given dates in the same quarter (and year)?
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Are the given dates in the same quarter (and year)?
|
||
|
|
*
|
||
|
|
* @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 dateLeft - The first date to check
|
||
|
|
* @param dateRight - The second date to check
|
||
|
|
|
||
|
|
* @returns The dates are in the same quarter (and year)
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Are 1 January 2014 and 8 March 2014 in the same quarter?
|
||
|
|
* const result = isSameQuarter(new Date(2014, 0, 1), new Date(2014, 2, 8))
|
||
|
|
* //=> true
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Are 1 January 2014 and 1 January 2015 in the same quarter?
|
||
|
|
* const result = isSameQuarter(new Date(2014, 0, 1), new Date(2015, 0, 1))
|
||
|
|
* //=> false
|
||
|
|
*/
|
||
|
|
export declare function isSameQuarter<DateType extends Date>(
|
||
|
|
dateLeft: DateType | number | string,
|
||
|
|
dateRight: DateType | number | string,
|
||
|
|
): boolean;
|