UNPKG

702 BTypeScriptView Raw
1/**
2 * @name isLastDayOfMonth
3 * @category Month Helpers
4 * @summary Is the given date the last day of a month?
5 *
6 * @description
7 * Is the given date the last day of a month?
8 *
9 * @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
10 *
11 * @param date - The date to check
12
13 * @returns The date is the last day of a month
14 *
15 * @example
16 * // Is 28 February 2014 the last day of a month?
17 * const result = isLastDayOfMonth(new Date(2014, 1, 28))
18 * //=> true
19 */
20export declare function isLastDayOfMonth<DateType extends Date>(
21 date: DateType | number | string,
22): boolean;