28 lines
789 B
JavaScript
28 lines
789 B
JavaScript
|
import { toDate } from "./toDate.mjs";
|
||
|
|
|
||
|
|
/**
|
||
|
|
* @name isFirstDayOfMonth
|
||
|
|
* @category Month Helpers
|
||
|
|
* @summary Is the given date the first day of a month?
|
||
|
|
*
|
||
|
|
* @description
|
||
|
|
* Is the given date the first 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 first day of a month
|
||
|
|
*
|
||
|
|
* @example
|
||
|
|
* // Is 1 September 2014 the first day of a month?
|
||
|
|
* const result = isFirstDayOfMonth(new Date(2014, 8, 1))
|
||
|
|
* //=> true
|
||
|
|
*/
|
||
|
|
export function isFirstDayOfMonth(date) {
|
||
|
|
return toDate(date).getDate() === 1;
|
||
|
|
}
|
||
|
|
|
||
|
|
// Fallback for modularized imports:
|
||
|
|
export default isFirstDayOfMonth;
|