49 lines
1.8 KiB
TypeScript
49 lines
1.8 KiB
TypeScript
|
import type { ContextOptions, DateArg, DateValues } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link set} function options.
|
||
|
|
*/
|
||
|
|
export interface SetOptions<DateType extends Date = Date>
|
||
|
|
extends ContextOptions<DateType> {}
|
||
|
|
/**
|
||
|
|
* @name set
|
||
|
|
* @category Common Helpers
|
||
|
|
* @summary Set date values to a given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Set date values to a given date.
|
||
|
|
*
|
||
|
|
* Sets time values to date from object `values`.
|
||
|
|
* A value is not set if it is undefined or null or doesn't exist in `values`.
|
||
|
|
*
|
||
|
|
* Note about bundle size: `set` does not internally use `setX` functions from date-fns but instead opts
|
||
|
|
* to use native `Date#setX` methods. If you use this function, you may not want to include the
|
||
|
|
* other `setX` functions that date-fns provides if you are concerned about the bundle size.
|
||
|
|
*
|
||
|
|
* @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 date to be changed
|
||
|
|
* @param values - The date values to be set
|
||
|
|
* @param options - The options
|
||
|
|
*
|
||
|
|
* @returns The new date with options set
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Transform 1 September 2014 into 20 October 2015 in a single line:
|
||
|
|
* const result = set(new Date(2014, 8, 20), { year: 2015, month: 9, date: 20 })
|
||
|
|
* //=> Tue Oct 20 2015 00:00:00
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Set 12 PM to 1 September 2014 01:23:45 to 1 September 2014 12:00:00:
|
||
|
|
* const result = set(new Date(2014, 8, 1, 1, 23, 45), { hours: 12 })
|
||
|
|
* //=> Mon Sep 01 2014 12:23:45
|
||
|
|
*/
|
||
|
|
export declare function set<
|
||
|
|
DateType extends Date,
|
||
|
|
ResultDate extends Date = DateType,
|
||
|
|
>(
|
||
|
|
date: DateArg<DateType>,
|
||
|
|
values: DateValues,
|
||
|
|
options?: SetOptions<ResultDate>,
|
||
|
|
): ResultDate;
|