hugoWebsite/node_modules/date-fns/esm/isSunday/index.js

24 lines
610 B
JavaScript

import toDate from "../toDate/index.js";
import requiredArgs from "../_lib/requiredArgs/index.js";
/**
* @name isSunday
* @category Weekday Helpers
* @summary Is the given date Sunday?
*
* @description
* Is the given date Sunday?
*
* @param {Date|Number} date - the date to check
* @returns {Boolean} the date is Sunday
* @throws {TypeError} 1 argument required
*
* @example
* // Is 21 September 2014 Sunday?
* const result = isSunday(new Date(2014, 8, 21))
* //=> true
*/
export default function isSunday(dirtyDate) {
requiredArgs(1, arguments);
return toDate(dirtyDate).getDay() === 0;
}