23 lines
708 B
TypeScript
23 lines
708 B
TypeScript
/**
|
|
* @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 declare function isFirstDayOfMonth<DateType extends Date>(
|
|
date: DateType | number | string,
|
|
): boolean;
|