Initial commit
This commit is contained in:
37
node_modules/date-fns/endOfWeek.d.ts
generated
vendored
Normal file
37
node_modules/date-fns/endOfWeek.d.ts
generated
vendored
Normal file
@ -0,0 +1,37 @@
|
||||
import type { LocalizedOptions, WeekOptions } from "./types.js";
|
||||
/**
|
||||
* The {@link endOfWeek} function options.
|
||||
*/
|
||||
export interface EndOfWeekOptions
|
||||
extends WeekOptions,
|
||||
LocalizedOptions<"options"> {}
|
||||
/**
|
||||
* @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).
|
||||
*
|
||||
* @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>(
|
||||
date: DateType | number | string,
|
||||
options?: EndOfWeekOptions,
|
||||
): DateType;
|
||||
Reference in New Issue
Block a user