55 lines
1.7 KiB
TypeScript
55 lines
1.7 KiB
TypeScript
import type {
|
|
FirstWeekContainsDateOptions,
|
|
LocalizedOptions,
|
|
WeekOptions,
|
|
} from "./types.js";
|
|
/**
|
|
* The {@link setWeek} function options.
|
|
*/
|
|
export interface SetWeekOptions
|
|
extends LocalizedOptions<"options">,
|
|
WeekOptions,
|
|
FirstWeekContainsDateOptions {}
|
|
/**
|
|
* @name setWeek
|
|
* @category Week Helpers
|
|
* @summary Set the local week to the given date.
|
|
*
|
|
* @description
|
|
* Set the local week to the given date, saving the weekday number.
|
|
* The exact calculation depends on the values of
|
|
* `options.weekStartsOn` (which is the index of the first day of the week)
|
|
* and `options.firstWeekContainsDate` (which is the day of January, which is always in
|
|
* the first week of the week-numbering year)
|
|
*
|
|
* Week numbering: https://en.wikipedia.org/wiki/Week#The_ISO_week_date_system
|
|
*
|
|
* @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 week - The week of the new date
|
|
* @param options - An object with options
|
|
*
|
|
* @returns The new date with the local week set
|
|
*
|
|
* @example
|
|
* // Set the 1st week to 2 January 2005 with default options:
|
|
* const result = setWeek(new Date(2005, 0, 2), 1)
|
|
* //=> Sun Dec 26 2004 00:00:00
|
|
*
|
|
* @example
|
|
* // Set the 1st week to 2 January 2005,
|
|
* // if Monday is the first day of the week,
|
|
* // and the first week of the year always contains 4 January:
|
|
* const result = setWeek(new Date(2005, 0, 2), 1, {
|
|
* weekStartsOn: 1,
|
|
* firstWeekContainsDate: 4
|
|
* })
|
|
* //=> Sun Jan 4 2004 00:00:00
|
|
*/
|
|
export declare function setWeek<DateType extends Date>(
|
|
date: DateType | number | string,
|
|
week: number,
|
|
options?: SetWeekOptions,
|
|
): DateType;
|