subQuarters.mjs 923 B

12345678910111213141516171819202122232425262728
  1. import { addQuarters } from "./addQuarters.mjs";
  2. /**
  3. * @name subQuarters
  4. * @category Quarter Helpers
  5. * @summary Subtract the specified number of year quarters from the given date.
  6. *
  7. * @description
  8. * Subtract the specified number of year quarters from the given date.
  9. *
  10. * @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).
  11. *
  12. * @param date - The date to be changed
  13. * @param amount - The amount of quarters to be subtracted.
  14. *
  15. * @returns The new date with the quarters subtracted
  16. *
  17. * @example
  18. * // Subtract 3 quarters from 1 September 2014:
  19. * const result = subQuarters(new Date(2014, 8, 1), 3)
  20. * //=> Sun Dec 01 2013 00:00:00
  21. */
  22. export function subQuarters(date, amount) {
  23. return addQuarters(date, -amount);
  24. }
  25. // Fallback for modularized imports:
  26. export default subQuarters;