UNPKG

851 BTypeScriptView Raw
1/**
2 * @name subSeconds
3 * @category Second Helpers
4 * @summary Subtract the specified number of seconds from the given date.
5 *
6 * @description
7 * Subtract the specified number of seconds from the given date.
8 *
9 * @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).
10 *
11 * @param date - The date to be changed
12 * @param amount - The amount of seconds to be subtracted.
13 *
14 * @returns The new date with the seconds subtracted
15 *
16 * @example
17 * // Subtract 30 seconds from 10 July 2014 12:45:00:
18 * const result = subSeconds(new Date(2014, 6, 10, 12, 45, 0), 30)
19 * //=> Thu Jul 10 2014 12:44:30
20 */
21export declare function subSeconds<DateType extends Date>(
22 date: DateType | number | string,
23 amount: number,
24): DateType;