47 lines
1.7 KiB
TypeScript
47 lines
1.7 KiB
TypeScript
|
import type { ConstructableDate, ContextFn, DateArg } from "./types.js";
|
||
|
|
/**
|
||
|
|
* @name toDate
|
||
|
|
* @category Common Helpers
|
||
|
|
* @summary Convert the given argument to an instance of Date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Convert the given argument to an instance of Date.
|
||
|
|
*
|
||
|
|
* If the argument is an instance of Date, the function returns its clone.
|
||
|
|
*
|
||
|
|
* If the argument is a number, it is treated as a timestamp.
|
||
|
|
*
|
||
|
|
* 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
|
||
|
|
*
|
||
|
|
* @returns The parsed date in the local time zone
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Clone the date:
|
||
|
|
* const result = toDate(new Date(2014, 1, 11, 11, 30, 30))
|
||
|
|
* //=> Tue Feb 11 2014 11:30:30
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Convert the timestamp to date:
|
||
|
|
* const result = toDate(1392098430000)
|
||
|
|
* //=> Tue Feb 11 2014 11:30:30
|
||
|
|
*/
|
||
|
|
export declare function toDate<
|
||
|
|
DateType extends Date | ConstructableDate,
|
||
|
|
ResultDate extends Date = DateType,
|
||
|
|
>(
|
||
|
|
argument: DateArg<DateType>,
|
||
|
|
context?: ContextFn<ResultDate> | undefined,
|
||
|
|
): ResultDate;
|