| 123456789101112131415161718192021222324252627282930313233343536373839404142434445 |
- import type { Duration } from "./types.js";
- /**
- * @name sub
- * @category Common Helpers
- * @summary Subtract the specified years, months, weeks, days, hours, minutes and seconds from the given date.
- *
- * @description
- * Subtract the specified years, months, weeks, days, hours, minutes and seconds 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).
- *
- * @param date - The date to be changed
- * @param duration - The object with years, months, weeks, days, hours, minutes and seconds to be subtracted
- *
- * | Key | Description |
- * |---------|------------------------------------|
- * | years | Amount of years to be subtracted |
- * | months | Amount of months to be subtracted |
- * | weeks | Amount of weeks to be subtracted |
- * | days | Amount of days to be subtracted |
- * | hours | Amount of hours to be subtracted |
- * | minutes | Amount of minutes to be subtracted |
- * | seconds | Amount of seconds to be subtracted |
- *
- * All values default to 0
- *
- * @returns The new date with the seconds subtracted
- *
- * @example
- * // Subtract the following duration from 15 June 2017 15:29:20
- * const result = sub(new Date(2017, 5, 15, 15, 29, 20), {
- * years: 2,
- * months: 9,
- * weeks: 1,
- * days: 7,
- * hours: 5,
- * minutes: 9,
- * seconds: 30
- * })
- * //=> Mon Sep 1 2014 10:19:50
- */
- export declare function sub<DateType extends Date>(
- date: DateType | number | string,
- duration: Duration,
- ): DateType;
|