25 lines
713 B
TypeScript
25 lines
713 B
TypeScript
|
import type { ContextOptions, DateArg } from "./types.js";
|
||
|
|
export interface IsLastDayOfMonthOptions extends ContextOptions<Date> {}
|
||
|
|
/**
|
||
|
|
* @name isLastDayOfMonth
|
||
|
|
* @category Month Helpers
|
||
|
|
* @summary Is the given date the last day of a month?
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Is the given date the last day of a month?
|
||
|
|
*
|
||
|
|
* @param date - The date to check
|
||
|
|
* @param options - An object with options
|
||
|
|
*
|
||
|
|
* @returns The date is the last day of a month
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Is 28 February 2014 the last day of a month?
|
||
|
|
* const result = isLastDayOfMonth(new Date(2014, 1, 28))
|
||
|
|
* //=> true
|
||
|
|
*/
|
||
|
|
export declare function isLastDayOfMonth(
|
||
|
|
date: DateArg<Date> & {},
|
||
|
|
options?: IsLastDayOfMonthOptions | undefined,
|
||
|
|
): boolean;
|