Skip to main content
Module

x/date_fns/isWeekend/index.ts

date-fns Deno package
Very Popular
Latest
File
import toDate from '../toDate/index.ts'import requiredArgs from '../_lib/requiredArgs/index.ts'
/** * @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? * const result = isWeekend(new Date(2014, 9, 5)) * //=> true */export default function isWeekend(dirtyDate: Date | number): boolean { requiredArgs(1, arguments)
const date = toDate(dirtyDate) const day = date.getDay() return day === 0 || day === 6}