diff options
Diffstat (limited to 'date-fns/src/isSunday/index.ts')
-rw-r--r-- | date-fns/src/isSunday/index.ts | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/date-fns/src/isSunday/index.ts b/date-fns/src/isSunday/index.ts new file mode 100644 index 0000000..cc3eba7 --- /dev/null +++ b/date-fns/src/isSunday/index.ts @@ -0,0 +1,29 @@ +import toDate from '../toDate/index' +import requiredArgs from '../_lib/requiredArgs/index' + +/** + * @name isSunday + * @category Weekday Helpers + * @summary Is the given date Sunday? + * + * @description + * Is the given date Sunday? + * + * ### 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 is Sunday + * @throws {TypeError} 1 argument required + * + * @example + * // Is 21 September 2014 Sunday? + * var result = isSunday(new Date(2014, 8, 21)) + * //=> true + */ +export default function isSunday(dirtyDate: Date | number): boolean { + requiredArgs(1, arguments) + + return toDate(dirtyDate).getDay() === 0 +} |