timepiece/node_modules/date-fns/getHours.mjs

30 lines
748 B
JavaScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
import { toDate } from "./toDate.mjs";
/**
* @name getHours
* @category Hour Helpers
* @summary Get the hours of the given date.
*
* @description
* Get the hours of 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 given date
*
* @returns The hours
*
* @example
* // Get the hours of 29 February 2012 11:45:00:
* const result = getHours(new Date(2012, 1, 29, 11, 45))
* //=> 11
*/
export function getHours(date) {
const _date = toDate(date);
const hours = _date.getHours();
return hours;
}
// Fallback for modularized imports:
export default getHours;