25 lines
847 B
TypeScript
25 lines
847 B
TypeScript
|
/**
|
||
|
|
* @name setMilliseconds
|
||
|
|
* @category Millisecond Helpers
|
||
|
|
* @summary Set the milliseconds to the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Set the milliseconds to the given date.
|
||
|
|
*
|
||
|
|
* @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 date to be changed
|
||
|
|
* @param milliseconds - The milliseconds of the new date
|
||
|
|
*
|
||
|
|
* @returns The new date with the milliseconds set
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Set 300 milliseconds to 1 September 2014 11:30:40.500:
|
||
|
|
* const result = setMilliseconds(new Date(2014, 8, 1, 11, 30, 40, 500), 300)
|
||
|
|
* //=> Mon Sep 01 2014 11:30:40.300
|
||
|
|
*/
|
||
|
|
export declare function setMilliseconds<DateType extends Date>(
|
||
|
|
date: DateType | number | string,
|
||
|
|
milliseconds: number,
|
||
|
|
): DateType;
|