import toDate from "../toDate/index.js"; import requiredArgs from "../_lib/requiredArgs/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? * * @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? * const result = isWeekend(new Date(2014, 9, 5)) * //=> true */ export default function isWeekend(dirtyDate) { requiredArgs(1, arguments); var date = toDate(dirtyDate); var day = date.getDay(); return day === 0 || day === 6; }