38 lines
1.2 KiB
TypeScript
38 lines
1.2 KiB
TypeScript
|
import type { LocalizedOptions, WeekOptions } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link startOfWeek} function options.
|
||
|
|
*/
|
||
|
|
export interface StartOfWeekOptions
|
||
|
|
extends LocalizedOptions<"options">,
|
||
|
|
WeekOptions {}
|
||
|
|
/**
|
||
|
|
* @name startOfWeek
|
||
|
|
* @category Week Helpers
|
||
|
|
* @summary Return the start of a week for the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Return the start 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 start of a week
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // The start of a week for 2 September 2014 11:55:00:
|
||
|
|
* const result = startOfWeek(new Date(2014, 8, 2, 11, 55, 0))
|
||
|
|
* //=> Sun Aug 31 2014 00:00:00
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // If the week starts on Monday, the start of the week for 2 September 2014 11:55:00:
|
||
|
|
* const result = startOfWeek(new Date(2014, 8, 2, 11, 55, 0), { weekStartsOn: 1 })
|
||
|
|
* //=> Mon Sep 01 2014 00:00:00
|
||
|
|
*/
|
||
|
|
export declare function startOfWeek<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
options?: StartOfWeekOptions,
|
||
|
|
): DateType;
|