UNPKG

1.28 kBTypeScriptView Raw
1import type { ContextOptions, DateArg } from "./types.js";
2/**
3 * The {@link setDate} function options.
4 */
5export interface SetDateOptions<DateType extends Date = Date>
6 extends ContextOptions<DateType> {}
7/**
8 * @name setDate
9 * @category Day Helpers
10 * @summary Set the day of the month to the given date.
11 *
12 * @description
13 * Set the day of the month to the given date.
14 *
15 * @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).
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 dayOfMonth - The day of the month of the new date
20 * @param options - The options
21 *
22 * @returns The new date with the day of the month set
23 *
24 * @example
25 * // Set the 30th day of the month to 1 September 2014:
26 * const result = setDate(new Date(2014, 8, 1), 30)
27 * //=> Tue Sep 30 2014 00:00:00
28 */
29export declare function setDate<
30 DateType extends Date,
31 ResultDate extends Date = DateType,
32>(
33 date: DateArg<DateType>,
34 dayOfMonth: number,
35 options?: SetDateOptions<ResultDate> | undefined,
36): ResultDate;