timepiece/node_modules/date-fns/addBusinessDays.d.mts

25 lines
922 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name addBusinessDays
* @category Date Extension Helpers
* @summary Add the specified number of business days (mon - fri) to the given date.
*
* @description
* Add the specified number of business days (mon - fri) to the given date, ignoring weekends.
*
* @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 be changed
* @param amount - The amount of business days to be added.
*
* @returns The new date with the business days added
*
* @example
* // Add 10 business days to 1 September 2014:
* const result = addBusinessDays(new Date(2014, 8, 1), 10)
* //=> Mon Sep 15 2014 00:00:00 (skipped weekend days)
*/
export declare function addBusinessDays<DateType extends Date>(
date: DateType | number | string,
amount: number,
): DateType;