📄 isFriday.js
/home/palash/git/site/node_modules/date-fns/isFriday.js
Language: js • Lines: 30
import { toDate } from "./toDate.js";

/**
 * The {@link isFriday} function options.
 */

/**
 * @name isFriday
 * @category Weekday Helpers
 * @summary Is the given date Friday?
 *
 * @description
 * Is the given date Friday?
 *
 * @param date - The date to check
 * @param options - An object with options
 *
 * @returns The date is Friday
 *
 * @example
 * // Is 26 September 2014 Friday?
 * const result = isFriday(new Date(2014, 8, 26))
 * //=> true
 */
export function isFriday(date, options) {
  return toDate(date, options?.in).getDay() === 5;
}

// Fallback for modularized imports:
export default isFriday;