timepiece/node_modules/date-fns/nextFriday.mjs

28 lines
730 B
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { nextDay } from "./nextDay.mjs";
/**
* @name nextFriday
* @category Weekday Helpers
* @summary When is the next Friday?
*
* @description
* When is the next Friday?
*
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
*
* @param date - The date to start counting from
*
* @returns The next Friday
*
* @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 function nextFriday(date) {
return nextDay(date, 5);
}
// Fallback for modularized imports:
export default nextFriday;