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,3 +1,4 @@
import type { ConstructableDate, ContextFn, DateArg } from "./types.js";
/**
* @name toDate
* @category Common Helpers
@@ -12,9 +13,15 @@
*
* If the argument is none of the above, the function returns Invalid Date.
*
* Starting from v3.7.0, it clones a date using `[Symbol.for("constructDateFrom")]`
* enabling to transfer extra properties from the reference date to the new date.
* It's useful for extensions like [`TZDate`](https://github.com/date-fns/tz)
* that accept a time zone as a constructor argument.
*
* **Note**: *all* Date arguments passed to any *date-fns* function is processed by `toDate`.
*
* @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 argument - The value to convert
*
@@ -30,6 +37,10 @@
* const result = toDate(1392098430000)
* //=> Tue Feb 11 2014 11:30:30
*/
export declare function toDate<DateType extends Date>(
argument: DateType | number | string,
): DateType;
export declare function toDate<
DateType extends Date | ConstructableDate,
ResultDate extends Date = DateType,
>(
argument: DateArg<DateType>,
context?: ContextFn<ResultDate> | undefined,
): ResultDate;