Skip to main content
Module

x/date_fns/isThisYear/index.ts

date-fns Deno package
Very Popular
Latest
File
import isSameYear from '../isSameYear/index.ts'import requiredArgs from '../_lib/requiredArgs/index.ts'
/** * @name isThisYear * @category Year Helpers * @summary Is the given date in the same year as the current date? * @pure false * * @description * Is the given date in the same year as the current date? * * > ⚠️ Please note that this function is not present in the FP submodule as * > it uses `Date.now()` internally hence impure and can't be safely curried. * * ### v2.0.0 breaking changes: * * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes). * * @param {Date|Number} date - the date to check * @returns {Boolean} the date is in this year * @throws {TypeError} 1 argument required * * @example * // If today is 25 September 2014, is 2 July 2014 in this year? * var result = isThisYear(new Date(2014, 6, 2)) * //=> true */export default function isThisYear(dirtyDate: Date | number): boolean { requiredArgs(1, arguments)
return isSameYear(dirtyDate, Date.now())}