UNPKG

713 BTypeScriptView Raw
1import type { ContextOptions, DateArg } from "./types.js";
2export interface IsLastDayOfMonthOptions extends ContextOptions<Date> {}
3/**
4 * @name isLastDayOfMonth
5 * @category Month Helpers
6 * @summary Is the given date the last day of a month?
7 *
8 * @description
9 * Is the given date the last day of a month?
10 *
11 * @param date - The date to check
12 * @param options - An object with options
13 *
14 * @returns The date is the last day of a month
15 *
16 * @example
17 * // Is 28 February 2014 the last day of a month?
18 * const result = isLastDayOfMonth(new Date(2014, 1, 28))
19 * //=> true
20 */
21export declare function isLastDayOfMonth(
22 date: DateArg<Date> & {},
23 options?: IsLastDayOfMonthOptions | undefined,
24): boolean;