timepiece/node_modules/date-fns/setDay.d.mts

39 lines
1.2 KiB
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import type { LocalizedOptions, WeekOptions } from "./types.js";
/**
* The {@link setDay} function options.
*/
export interface SetDayOptions
extends LocalizedOptions<"options">,
WeekOptions {}
/**
* @name setDay
* @category Weekday Helpers
* @summary Set the day of the week to the given date.
*
* @description
* Set the day of the week 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).
*
* @param date - The date to be changed
* @param day - The day of the week of the new date
* @param options - An object with options.
*
* @returns The new date with the day of the week set
*
* @example
* // Set week day to Sunday, with the default weekStartsOn of Sunday:
* const result = setDay(new Date(2014, 8, 1), 0)
* //=> Sun Aug 31 2014 00:00:00
*
* @example
* // Set week day to Sunday, with a weekStartsOn of Monday:
* const result = setDay(new Date(2014, 8, 1), 0, { weekStartsOn: 1 })
* //=> Sun Sep 07 2014 00:00:00
*/
export declare function setDay<DateType extends Date>(
date: DateType | number | string,
day: number,
options?: SetDayOptions,
): DateType;