28 lines
677 B
TypeScript
28 lines
677 B
TypeScript
import type { ContextOptions, DateArg } from "./types.js";
|
|
/**
|
|
* The {@link getHours} function options.
|
|
*/
|
|
export interface GetHoursOptions extends ContextOptions<Date> {}
|
|
/**
|
|
* @name getHours
|
|
* @category Hour Helpers
|
|
* @summary Get the hours of the given date.
|
|
*
|
|
* @description
|
|
* Get the hours of the given date.
|
|
*
|
|
* @param date - The given date
|
|
* @param options - An object with options
|
|
*
|
|
* @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 declare function getHours(
|
|
date: DateArg<Date> & {},
|
|
options?: GetHoursOptions | undefined,
|
|
): number;
|