74 lines
2.9 KiB
TypeScript
74 lines
2.9 KiB
TypeScript
import type { ContextOptions, DateArg, Duration } from "./types.ts";
|
|
/**
|
|
* The {@link add} function options.
|
|
*/
|
|
export interface AddOptions<DateType extends Date = Date>
|
|
extends ContextOptions<DateType> {}
|
|
/**
|
|
* @name add
|
|
* @category Common Helpers
|
|
* @summary Add the specified years, months, weeks, days, hours, minutes, and seconds to the given date.
|
|
*
|
|
* @description
|
|
* Add the specified years, months, weeks, days, hours, minutes, and seconds to the given date.
|
|
*
|
|
* **You don't need date-fns\***:
|
|
*
|
|
* Temporal has a built-in `add` method on all its classes:
|
|
*
|
|
* - [`Temporal.Instant.prototype.add()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Temporal/Instant/add)
|
|
* - [`Temporal.PlainDate.prototype.add()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Temporal/PlainDate/add)
|
|
* - [`Temporal.PlainDateTime.prototype.add()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Temporal/PlainDateTime/add)
|
|
* - [`Temporal.PlainTime.prototype.add()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Temporal/PlainTime/add)
|
|
* - [`Temporal.PlainYearMonth.prototype.add()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Temporal/PlainYearMonth/add)
|
|
* - [`Temporal.ZonedDateTime.prototype.add()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Temporal/ZonedDateTime/add)
|
|
*
|
|
* \* **Not really**, see: https://date-fns.org/you-dont-need-date-fns
|
|
*
|
|
* @typeParam DateType - The `Date` type the function operates on. Gets inferred from passed arguments. Allows using 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 added.
|
|
* @param options - An object with options
|
|
*
|
|
* @returns The new date with the seconds added
|
|
*
|
|
* @example
|
|
* // Add the following duration to 1 September 2014, 10:19:50
|
|
* const result = add(new Date(2014, 8, 1, 10, 19, 50), {
|
|
* years: 2,
|
|
* months: 9,
|
|
* weeks: 1,
|
|
* days: 7,
|
|
* hours: 5,
|
|
* minutes: 9,
|
|
* seconds: 30,
|
|
* })
|
|
* //=> Thu Jun 15 2017 15:29:20
|
|
*
|
|
* @example
|
|
* // Using Temporal:
|
|
* // Add the following duration to 1 September 2014, 10:19:50
|
|
* Temporal.PlainDateTime.from("2014-09-01T10:19:50")
|
|
* .add({
|
|
* years: 2,
|
|
* months: 9,
|
|
* weeks: 1,
|
|
* days: 7,
|
|
* hours: 5,
|
|
* minutes: 9,
|
|
* seconds: 30,
|
|
* })
|
|
* .toString();
|
|
* //=> "2017-06-15T15:29:20"
|
|
*/
|
|
export declare function add<
|
|
DateType extends Date,
|
|
ResultDate extends Date = DateType,
|
|
>(
|
|
date: DateArg<DateType>,
|
|
duration: Duration,
|
|
options?: AddOptions<ResultDate> | undefined,
|
|
): ResultDate;
|