29 lines
796 B
TypeScript
29 lines
796 B
TypeScript
|
import type { ContextOptions, DateArg } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link isThisMonth} function options.
|
||
|
|
*/
|
||
|
|
export interface IsThisMonthOptions extends ContextOptions<Date> {}
|
||
|
|
/**
|
||
|
|
* @name isThisMonth
|
||
|
|
* @category Month Helpers
|
||
|
|
* @summary Is the given date in the same month as the current date?
|
||
|
|
* @pure false
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Is the given date in the same month as the current date?
|
||
|
|
*
|
||
|
|
* @param date - The date to check
|
||
|
|
* @param options - An object with options
|
||
|
|
*
|
||
|
|
* @returns The date is in this month
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // If today is 25 September 2014, is 15 September 2014 in this month?
|
||
|
|
* const result = isThisMonth(new Date(2014, 8, 15))
|
||
|
|
* //=> true
|
||
|
|
*/
|
||
|
|
export declare function isThisMonth(
|
||
|
|
date: DateArg<Date> & {},
|
||
|
|
options?: IsThisMonthOptions | undefined,
|
||
|
|
): boolean;
|