timepiece/node_modules/date-fns/setSeconds.d.ts

25 lines
777 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name setSeconds
* @category Second Helpers
* @summary Set the seconds to the given date.
*
* @description
* Set the seconds 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 seconds - The seconds of the new date
*
* @returns The new date with the seconds set
*
* @example
* // Set 45 seconds to 1 September 2014 11:30:40:
* const result = setSeconds(new Date(2014, 8, 1, 11, 30, 40), 45)
* //=> Mon Sep 01 2014 11:30:45
*/
export declare function setSeconds<DateType extends Date>(
date: DateType | number | string,
seconds: number,
): DateType;