37 lines
1.2 KiB
TypeScript
37 lines
1.2 KiB
TypeScript
|
import type { GenericDateConstructor } from "./types.js";
|
||
|
|
/**
|
||
|
|
* @name transpose
|
||
|
|
* @category Generic Helpers
|
||
|
|
* @summary Transpose the date to the given constructor.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* The function transposes the date to the given constructor. It helps you
|
||
|
|
* to transpose the date in the system time zone to say `UTCDate` or any other
|
||
|
|
* date extension.
|
||
|
|
*
|
||
|
|
* @typeParam DateInputType - The input `Date` type derived from the passed argument.
|
||
|
|
* @typeParam DateOutputType - The output `Date` type derived from the passed constructor.
|
||
|
|
*
|
||
|
|
* @param fromDate - The date to use values from
|
||
|
|
* @param constructor - The date constructor to use
|
||
|
|
*
|
||
|
|
* @returns Date transposed to the given constructor
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Create July 10, 2022 00:00 in locale time zone
|
||
|
|
* const date = new Date(2022, 6, 10)
|
||
|
|
* //=> 'Sun Jul 10 2022 00:00:00 GMT+0800 (Singapore Standard Time)'
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Transpose the date to July 10, 2022 00:00 in UTC
|
||
|
|
* transpose(date, UTCDate)
|
||
|
|
* //=> 'Sun Jul 10 2022 00:00:00 GMT+0000 (Coordinated Universal Time)'
|
||
|
|
*/
|
||
|
|
export declare function transpose<
|
||
|
|
DateInputType extends Date,
|
||
|
|
DateOutputType extends Date,
|
||
|
|
>(
|
||
|
|
fromDate: DateInputType,
|
||
|
|
constructor: DateOutputType | GenericDateConstructor<DateOutputType>,
|
||
|
|
): DateOutputType;
|