timepiece/node_modules/date-fns/sub.mjs

73 lines
2.3 KiB
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { subDays } from "./subDays.mjs";
import { subMonths } from "./subMonths.mjs";
import { constructFrom } from "./constructFrom.mjs";
/**
* @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 function sub(date, duration) {
const {
years = 0,
months = 0,
weeks = 0,
days = 0,
hours = 0,
minutes = 0,
seconds = 0,
} = duration;
// Subtract years and months
const dateWithoutMonths = subMonths(date, months + years * 12);
// Subtract weeks and days
const dateWithoutDays = subDays(dateWithoutMonths, days + weeks * 7);
// Subtract hours, minutes and seconds
const minutestoSub = minutes + hours * 60;
const secondstoSub = seconds + minutestoSub * 60;
const mstoSub = secondstoSub * 1000;
const finalDate = constructFrom(date, dateWithoutDays.getTime() - mstoSub);
return finalDate;
}
// Fallback for modularized imports:
export default sub;