import addDays from '../addDays/index' import requiredArgs from '../_lib/requiredArgs/index' import toInteger from '../_lib/toInteger/index' /** * @name subDays * @category Day Helpers * @summary Subtract the specified number of days from the given date. * * @description * Subtract the specified number of days from the given date. * * @param {Date|Number} date - the date to be changed * @param {Number} amount - the amount of days 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 days subtracted * @throws {TypeError} 2 arguments required * * @example * // Subtract 10 days from 1 September 2014: * const result = subDays(new Date(2014, 8, 1), 10) * //=> Fri Aug 22 2014 00:00:00 */ export default function subDays( dirtyDate: Date | number, dirtyAmount: number ): Date { requiredArgs(2, arguments) const amount = toInteger(dirtyAmount) return addDays(dirtyDate, -amount) }