31 lines
956 B
JavaScript
31 lines
956 B
JavaScript
import { toDate } from "./toDate.mjs";
|
|
|
|
/**
|
|
* @name isSameYear
|
|
* @category Year Helpers
|
|
* @summary Are the given dates in the same year?
|
|
*
|
|
* @description
|
|
* Are the given dates in the same 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 year
|
|
*
|
|
* @example
|
|
* // Are 2 September 2014 and 25 September 2014 in the same year?
|
|
* const result = isSameYear(new Date(2014, 8, 2), new Date(2014, 8, 25))
|
|
* //=> true
|
|
*/
|
|
export function isSameYear(dateLeft, dateRight) {
|
|
const _dateLeft = toDate(dateLeft);
|
|
const _dateRight = toDate(dateRight);
|
|
return _dateLeft.getFullYear() === _dateRight.getFullYear();
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default isSameYear;
|