📝 Commit Details:
This commit is contained in:
48
backend/node_modules/date-fns/setDay.d.ts
generated
vendored
Normal file
48
backend/node_modules/date-fns/setDay.d.ts
generated
vendored
Normal file
@@ -0,0 +1,48 @@
|
||||
import type {
|
||||
ContextOptions,
|
||||
DateArg,
|
||||
LocalizedOptions,
|
||||
WeekOptions,
|
||||
} from "./types.js";
|
||||
/**
|
||||
* The {@link setDay} function options.
|
||||
*/
|
||||
export interface SetDayOptions<DateType extends Date = Date>
|
||||
extends LocalizedOptions<"options">,
|
||||
WeekOptions,
|
||||
ContextOptions<DateType> {}
|
||||
/**
|
||||
* @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).
|
||||
* @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 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,
|
||||
ResultDate extends Date = DateType,
|
||||
>(
|
||||
date: DateArg<DateType>,
|
||||
day: number,
|
||||
options?: SetDayOptions<ResultDate>,
|
||||
): ResultDate;
|
Reference in New Issue
Block a user