import type { ContextOptions, DateArg } from "./types.js"; /** * The {@link subDays} function options. */ export interface SubDaysOptions extends ContextOptions {} /** * @name subDays * @category Day Helpers * @summary Subtract the specified number of days from the given date. * * @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). * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments. * * @param date - The date to be changed * @param amount - The amount of days to be subtracted. * @param options - An object with options * * @returns The new date with the days subtracted * * @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 declare function subDays< DateType extends Date, ResultDate extends Date = DateType, >( date: DateArg, amount: number, options?: SubDaysOptions | undefined, ): ResultDate;