25 lines
851 B
TypeScript
25 lines
851 B
TypeScript
/**
|
|
* @name subSeconds
|
|
* @category Second Helpers
|
|
* @summary Subtract the specified number of seconds from the given date.
|
|
*
|
|
* @description
|
|
* Subtract the specified number of seconds from 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 amount - The amount of seconds to be subtracted.
|
|
*
|
|
* @returns The new date with the seconds subtracted
|
|
*
|
|
* @example
|
|
* // Subtract 30 seconds from 10 July 2014 12:45:00:
|
|
* const result = subSeconds(new Date(2014, 6, 10, 12, 45, 0), 30)
|
|
* //=> Thu Jul 10 2014 12:44:30
|
|
*/
|
|
export declare function subSeconds<DateType extends Date>(
|
|
date: DateType | number | string,
|
|
amount: number,
|
|
): DateType;
|