UNPKG

677 BTypeScriptView Raw
1import type { ContextOptions, DateArg } from "./types.js";
2/**
3 * The {@link getHours} function options.
4 */
5export interface GetHoursOptions extends ContextOptions<Date> {}
6/**
7 * @name getHours
8 * @category Hour Helpers
9 * @summary Get the hours of the given date.
10 *
11 * @description
12 * Get the hours of the given date.
13 *
14 * @param date - The given date
15 * @param options - An object with options
16 *
17 * @returns The hours
18 *
19 * @example
20 * // Get the hours of 29 February 2012 11:45:00:
21 * const result = getHours(new Date(2012, 1, 29, 11, 45))
22 * //=> 11
23 */
24export declare function getHours(
25 date: DateArg<Date> & {},
26 options?: GetHoursOptions | undefined,
27): number;