| 1 | import type { ContextOptions, DateArg } from "./types.js";
|
| 2 | /**
|
| 3 | * The {@link addQuarters} function options.
|
| 4 | */
|
| 5 | export interface AddQuartersOptions<DateType extends Date = Date>
|
| 6 | extends ContextOptions<DateType> {}
|
| 7 | /**
|
| 8 | * @name addQuarters
|
| 9 | * @category Quarter Helpers
|
| 10 | * @summary Add the specified number of year quarters to the given date.
|
| 11 | *
|
| 12 | * @description
|
| 13 | * Add the specified number of year quarters to the given date.
|
| 14 | *
|
| 15 | * @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).
|
| 16 | * @typeParam ResultDate - The result `Date` type, it is the type returned from the context function if it is passed, or inferred from the arguments.
|
| 17 | *
|
| 18 | * @param date - The date to be changed
|
| 19 | * @param amount - The amount of quarters to be added.
|
| 20 | * @param options - An object with options
|
| 21 | *
|
| 22 | * @returns The new date with the quarters added
|
| 23 | *
|
| 24 | * @example
|
| 25 | * // Add 1 quarter to 1 September 2014:
|
| 26 | * const result = addQuarters(new Date(2014, 8, 1), 1)
|
| 27 | * //=; Mon Dec 01 2014 00:00:00
|
| 28 | */
|
| 29 | export declare function addQuarters<
|
| 30 | DateType extends Date,
|
| 31 | ResultDate extends Date = DateType,
|
| 32 | >(
|
| 33 | date: DateArg<DateType>,
|
| 34 | amount: number,
|
| 35 | options?: AddQuartersOptions<ResultDate> | undefined,
|
| 36 | ): ResultDate;
|