UNPKG

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