29 lines
766 B
JavaScript
29 lines
766 B
JavaScript
|
import { toDate } from "./toDate.mjs";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name isWeekend
|
||
|
|
* @category Weekday Helpers
|
||
|
|
* @summary Does the given date fall on a weekend?
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Does the given date fall on a weekend?
|
||
|
|
*
|
||
|
|
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
|
||
|
|
*
|
||
|
|
* @param date - The date to check
|
||
|
|
*
|
||
|
|
* @returns The date falls on a weekend
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Does 5 October 2014 fall on a weekend?
|
||
|
|
* const result = isWeekend(new Date(2014, 9, 5))
|
||
|
|
* //=> true
|
||
|
|
*/
|
||
|
|
export function isWeekend(date) {
|
||
|
|
const day = toDate(date).getDay();
|
||
|
|
return day === 0 || day === 6;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default isWeekend;
|