Marc Mintel
5397309103
Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
32 lines
750 B
Plaintext
32 lines
750 B
Plaintext
import { toDate } from "./toDate.js";
|
|
|
|
/**
|
|
* The {@link isWeekend} function options.
|
|
*/
|
|
|
|
/**
|
|
* @name isWeekend
|
|
* @category Weekday Helpers
|
|
* @summary Does the given date fall on a weekend?
|
|
*
|
|
* @description
|
|
* Does the given date fall on a weekend? A weekend is either Saturday (`6`) or Sunday (`0`).
|
|
*
|
|
* @param date - The date to check
|
|
* @param options - An object with options
|
|
*
|
|
* @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, options) {
|
|
const day = toDate(date, options?.in).getDay();
|
|
return day === 0 || day === 6;
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default isWeekend;
|