37 lines
1.2 KiB
JavaScript
37 lines
1.2 KiB
JavaScript
import { startOfQuarter } from "./startOfQuarter.mjs";
|
|
|
|
/**
|
|
* @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 function isSameQuarter(dateLeft, dateRight) {
|
|
const dateLeftStartOfQuarter = startOfQuarter(dateLeft);
|
|
const dateRightStartOfQuarter = startOfQuarter(dateRight);
|
|
|
|
return +dateLeftStartOfQuarter === +dateRightStartOfQuarter;
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default isSameQuarter;
|