timepiece/node_modules/date-fns/isThisQuarter.mjs

30 lines
906 B
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { constructNow } from "./constructNow.mjs";
import { isSameQuarter } from "./isSameQuarter.mjs";
/**
* @name isThisQuarter
* @category Quarter Helpers
* @summary Is the given date in the same quarter as the current date?
* @pure false
*
* @description
* Is the given date in the same quarter as the current 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 date to check
*
* @returns The date is in this quarter
*
* @example
* // If today is 25 September 2014, is 2 July 2014 in this quarter?
* const result = isThisQuarter(new Date(2014, 6, 2))
* //=> true
*/
export function isThisQuarter(date) {
return isSameQuarter(date, constructNow(date));
}
// Fallback for modularized imports:
export default isThisQuarter;