45 lines
1.5 KiB
TypeScript
45 lines
1.5 KiB
TypeScript
|
import type {
|
||
|
|
ContextOptions,
|
||
|
|
DateArg,
|
||
|
|
LocalizedOptions,
|
||
|
|
WeekOptions,
|
||
|
|
} from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link endOfWeek} function options.
|
||
|
|
*/
|
||
|
|
export interface EndOfWeekOptions<DateType extends Date = Date>
|
||
|
|
extends WeekOptions,
|
||
|
|
LocalizedOptions<"options">,
|
||
|
|
ContextOptions<DateType> {}
|
||
|
|
/**
|
||
|
|
* @name endOfWeek
|
||
|
|
* @category Week Helpers
|
||
|
|
* @summary Return the end of a week for the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Return the end of a week for the given date.
|
||
|
|
* The result will be in the local timezone.
|
||
|
|
*
|
||
|
|
* @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 original date
|
||
|
|
* @param options - An object with options
|
||
|
|
*
|
||
|
|
* @returns The end of a week
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // The end of a week for 2 September 2014 11:55:00:
|
||
|
|
* const result = endOfWeek(new Date(2014, 8, 2, 11, 55, 0))
|
||
|
|
* //=> Sat Sep 06 2014 23:59:59.999
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // If the week starts on Monday, the end of the week for 2 September 2014 11:55:00:
|
||
|
|
* const result = endOfWeek(new Date(2014, 8, 2, 11, 55, 0), { weekStartsOn: 1 })
|
||
|
|
* //=> Sun Sep 07 2014 23:59:59.999
|
||
|
|
*/
|
||
|
|
export declare function endOfWeek<
|
||
|
|
DateType extends Date,
|
||
|
|
ResultDate extends Date = DateType,
|
||
|
|
>(date: DateArg<DateType>, options?: EndOfWeekOptions<ResultDate>): ResultDate;
|