import toDate from '../toDate/index.js'; /** * @name isWeekend * @category Weekday Helpers * @summary Does the given date fall on a weekend? * * @description * Does the given date fall on a weekend? * * ### 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 falls on a weekend * @throws {TypeError} 1 argument required * * @example * // Does 5 October 2014 fall on a weekend? * var result = isWeekend(new Date(2014, 9, 5)) * //=> true */ export default function isWeekend(dirtyDate) { if (arguments.length < 1) { throw new TypeError('1 argument required, but only ' + arguments.length + ' present'); } var date = toDate(dirtyDate); var day = date.getDay(); return day === 0 || day === 6; }