import toDate from '../toDate/index.js'; import endOfDay from '../endOfDay/index.js'; import endOfMonth from '../endOfMonth/index.js'; /** * @name isLastDayOfMonth * @category Month Helpers * @summary Is the given date the last day of a month? * * @description * Is the given date the last day of a month? * * ### 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 the last day of a month * @throws {TypeError} 1 argument required * * @example * // Is 28 February 2014 the last day of a month? * var result = isLastDayOfMonth(new Date(2014, 1, 28)) * //=> true */ export default function isLastDayOfMonth(dirtyDate) { if (arguments.length < 1) { throw new TypeError('1 argument required, but only ' + arguments.length + ' present'); } var date = toDate(dirtyDate); return endOfDay(date).getTime() === endOfMonth(date).getTime(); }