35 lines
1.2 KiB
TypeScript
35 lines
1.2 KiB
TypeScript
|
/**
|
||
|
|
* @name constructFrom
|
||
|
|
* @category Generic Helpers
|
||
|
|
* @summary Constructs a date using the reference date and the value
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* The function constructs a new date using the constructor from the reference
|
||
|
|
* date and the given value. It helps to build generic functions that accept
|
||
|
|
* date extensions.
|
||
|
|
*
|
||
|
|
* It defaults to `Date` if the passed reference date is a number or a string.
|
||
|
|
*
|
||
|
|
* @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 reference date to take constructor from
|
||
|
|
* @param value - The value to create the date
|
||
|
|
*
|
||
|
|
* @returns Date initialized using the given date and value
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* import { constructFrom } from 'date-fns'
|
||
|
|
*
|
||
|
|
* // A function that clones a date preserving the original type
|
||
|
|
* function cloneDate<DateType extends Date(date: DateType): DateType {
|
||
|
|
* return constructFrom(
|
||
|
|
* date, // Use contrustor from the given date
|
||
|
|
* date.getTime() // Use the date value to create a new date
|
||
|
|
* )
|
||
|
|
* }
|
||
|
|
*/
|
||
|
|
export declare function constructFrom<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
value: Date | number | string,
|
||
|
|
): DateType;
|