12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273 |
- import { constructFrom } from "./constructFrom.js";
- import { subDays } from "./subDays.js";
- import { subMonths } from "./subMonths.js";
- /**
- * The {@link sub} function options.
- */
- /**
- * @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).
- * @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 duration - The object with years, months, weeks, days, hours, minutes and seconds to be subtracted
- * @param options - An object with options
- *
- * | 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 function sub(date, duration, options) {
- const {
- years = 0,
- months = 0,
- weeks = 0,
- days = 0,
- hours = 0,
- minutes = 0,
- seconds = 0,
- } = duration;
- const withoutMonths = subMonths(date, months + years * 12, options);
- const withoutDays = subDays(withoutMonths, days + weeks * 7, options);
- const minutesToSub = minutes + hours * 60;
- const secondsToSub = seconds + minutesToSub * 60;
- const msToSub = secondsToSub * 1000;
- return constructFrom(options?.in || date, +withoutDays - msToSub);
- }
- // Fallback for modularized imports:
- export default sub;
|