diff options
Diffstat (limited to 'node_modules/date-fns/esm/subHours/index.js')
| -rw-r--r-- | node_modules/date-fns/esm/subHours/index.js | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/node_modules/date-fns/esm/subHours/index.js b/node_modules/date-fns/esm/subHours/index.js new file mode 100644 index 0000000..080683e --- /dev/null +++ b/node_modules/date-fns/esm/subHours/index.js @@ -0,0 +1,26 @@ +import addHours from "../addHours/index.js"; +import requiredArgs from "../_lib/requiredArgs/index.js"; +import toInteger from "../_lib/toInteger/index.js"; +/** + * @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. + * + * @param {Date|Number} date - the date to be changed + * @param {Number} amount - the amount of hours to be subtracted. Positive decimals will be rounded using `Math.floor`, decimals less than zero will be rounded using `Math.ceil`. + * @returns {Date} the new date with the hours subtracted + * @throws {TypeError} 2 arguments required + * + * @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 default function subHours(dirtyDate, dirtyAmount) { + requiredArgs(2, arguments); + var amount = toInteger(dirtyAmount); + return addHours(dirtyDate, -amount); +}
\ No newline at end of file |