timepiece/node_modules/date-fns/isLastDayOfMonth.mjs

31 lines
913 B
JavaScript

import { endOfDay } from "./endOfDay.mjs";
import { endOfMonth } from "./endOfMonth.mjs";
import { toDate } from "./toDate.mjs";
/**
* @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?
*
* @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).
*
* @param date - The date to check
* @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 function isLastDayOfMonth(date) {
const _date = toDate(date);
return +endOfDay(_date) === +endOfMonth(_date);
}
// Fallback for modularized imports:
export default isLastDayOfMonth;