diff options
Diffstat (limited to 'date-fns/src/nextFriday/index.ts')
-rw-r--r-- | date-fns/src/nextFriday/index.ts | 25 |
1 files changed, 25 insertions, 0 deletions
diff --git a/date-fns/src/nextFriday/index.ts b/date-fns/src/nextFriday/index.ts new file mode 100644 index 0000000..28d02bc --- /dev/null +++ b/date-fns/src/nextFriday/index.ts @@ -0,0 +1,25 @@ +import requiredArgs from '../_lib/requiredArgs/index' +import nextDay from '../nextDay/index' +import toDate from '../toDate/index' + +/** + * @name nextFriday + * @category Weekday Helpers + * @summary When is the next Friday? + * + * @description + * When is the next Friday? + * + * @param {Date | number} date - the date to start counting from + * @returns {Date} the next Friday + * @throws {TypeError} 1 argument required + * + * @example + * // When is the next Friday after Mar, 22, 2020? + * const result = nextFriday(new Date(2020, 2, 22)) + * //=> Fri Mar 27 2020 00:00:00 + */ +export default function nextFriday(date: Date | number): Date { + requiredArgs(1, arguments) + return nextDay(toDate(date), 5) +} |