27 lines
848 B
JavaScript
27 lines
848 B
JavaScript
|
import toDate from "../toDate/index.js";
|
||
|
|
import endOfDay from "../endOfDay/index.js";
|
||
|
|
import endOfMonth from "../endOfMonth/index.js";
|
||
|
|
import requiredArgs from "../_lib/requiredArgs/index.js";
|
||
|
|
/**
|
||
|
|
* @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|Number} date - the date to check
|
||
|
|
* @returns {Boolean} the date is the last day of a month
|
||
|
|
* @throws {TypeError} 1 argument required
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Is 28 February 2014 the last day of a month?
|
||
|
|
* const result = isLastDayOfMonth(new Date(2014, 1, 28))
|
||
|
|
* //=> true
|
||
|
|
*/
|
||
|
|
|
||
|
|
export default function isLastDayOfMonth(dirtyDate) {
|
||
|
|
requiredArgs(1, arguments);
|
||
|
|
var date = toDate(dirtyDate);
|
||
|
|
return endOfDay(date).getTime() === endOfMonth(date).getTime();
|
||
|
|
}
|