diff options
Diffstat (limited to 'date-fns/src/subWeeks/index.ts')
-rw-r--r-- | date-fns/src/subWeeks/index.ts | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/date-fns/src/subWeeks/index.ts b/date-fns/src/subWeeks/index.ts new file mode 100644 index 0000000..d12d2a0 --- /dev/null +++ b/date-fns/src/subWeeks/index.ts @@ -0,0 +1,32 @@ +import toInteger from '../_lib/toInteger/index' +import addWeeks from '../addWeeks/index' +import requiredArgs from '../_lib/requiredArgs/index' + +/** + * @name subWeeks + * @category Week Helpers + * @summary Subtract the specified number of weeks from the given date. + * + * @description + * Subtract the specified number of weeks from the given date. + * + * ### 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 be changed + * @param {Number} amount - the amount of weeks to be subtracted. Positive decimals will be rounded using `Math.floor`, decimals less than zero will be rounded using `Math.ceil`. + * @returns {Date} the new date with the weeks subtracted + * @throws {TypeError} 2 arguments required + * + * @example + * // Subtract 4 weeks from 1 September 2014: + * const result = subWeeks(new Date(2014, 8, 1), 4) + * //=> Mon Aug 04 2014 00:00:00 + */ +export default function subWeeks(dirtyDate: Date | number, dirtyAmount: number): Date { + requiredArgs(2, arguments) + + const amount = toInteger(dirtyAmount) + return addWeeks(dirtyDate, -amount) +} |