37 lines
1.3 KiB
TypeScript
37 lines
1.3 KiB
TypeScript
|
import type { ContextOptions, DateArg } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link addMinutes} function options.
|
||
|
|
*/
|
||
|
|
export interface AddMinutesOptions<DateType extends Date = Date>
|
||
|
|
extends ContextOptions<DateType> {}
|
||
|
|
/**
|
||
|
|
* @name addMinutes
|
||
|
|
* @category Minute Helpers
|
||
|
|
* @summary Add the specified number of minutes to the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Add the specified number of minutes to 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 amount - The amount of minutes to be added.
|
||
|
|
* @param options - An object with options
|
||
|
|
*
|
||
|
|
* @returns The new date with the minutes added
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Add 30 minutes to 10 July 2014 12:00:00:
|
||
|
|
* const result = addMinutes(new Date(2014, 6, 10, 12, 0), 30)
|
||
|
|
* //=> Thu Jul 10 2014 12:30:00
|
||
|
|
*/
|
||
|
|
export declare function addMinutes<
|
||
|
|
DateType extends Date,
|
||
|
|
ResultDate extends Date = DateType,
|
||
|
|
>(
|
||
|
|
date: DateArg<DateType>,
|
||
|
|
amount: number,
|
||
|
|
options?: AddMinutesOptions<ResultDate> | undefined,
|
||
|
|
): ResultDate;
|