registration

This commit is contained in:
User
2025-02-02 16:08:03 +03:00
parent 7f6495eb4d
commit 78afbaed71
6334 changed files with 196774 additions and 165754 deletions

View File

@@ -1,10 +1,16 @@
import type { LocalizedOptions, WeekOptions } from "./types.js";
import type {
ContextOptions,
DateArg,
LocalizedOptions,
WeekOptions,
} from "./types.js";
/**
* The {@link startOfWeek} function options.
*/
export interface StartOfWeekOptions
export interface StartOfWeekOptions<DateType extends Date = Date>
extends LocalizedOptions<"options">,
WeekOptions {}
WeekOptions,
ContextOptions<DateType> {}
/**
* @name startOfWeek
* @category Week Helpers
@@ -15,6 +21,7 @@ export interface StartOfWeekOptions
* 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
@@ -31,7 +38,10 @@ export interface StartOfWeekOptions
* 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;
export declare function startOfWeek<
DateType extends Date,
ResultDate extends Date = DateType,
>(
date: DateArg<DateType>,
options?: StartOfWeekOptions<ResultDate>,
): ResultDate;