29 lines
886 B
JavaScript
29 lines
886 B
JavaScript
|
import { addHours } from "./addHours.mjs";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name subHours
|
||
|
|
* @category Hour Helpers
|
||
|
|
* @summary Subtract the specified number of hours from the given date.
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Subtract the specified number of hours 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 hours to be subtracted.
|
||
|
|
*
|
||
|
|
* @returns The new date with the hours subtracted
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Subtract 2 hours from 11 July 2014 01:00:00:
|
||
|
|
* const result = subHours(new Date(2014, 6, 11, 1, 0), 2)
|
||
|
|
* //=> Thu Jul 10 2014 23:00:00
|
||
|
|
*/
|
||
|
|
export function subHours(date, amount) {
|
||
|
|
return addHours(date, -amount);
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default subHours;
|