| 1 | import type { ContextOptions, DateArg } from "./types.js";
|
| 2 | /**
|
| 3 | * The {@link isFirstDayOfMonth} function options.
|
| 4 | */
|
| 5 | export interface IsFirstDayOfMonthOptions extends ContextOptions<Date> {}
|
| 6 | /**
|
| 7 | * @name isFirstDayOfMonth
|
| 8 | * @category Month Helpers
|
| 9 | * @summary Is the given date the first day of a month?
|
| 10 | *
|
| 11 | * @description
|
| 12 | * Is the given date the first day of a month?
|
| 13 | *
|
| 14 | * @param date - The date to check
|
| 15 | * @param options - An object with options
|
| 16 | *
|
| 17 | * @returns The date is the first day of a month
|
| 18 | *
|
| 19 | * @example
|
| 20 | * // Is 1 September 2014 the first day of a month?
|
| 21 | * const result = isFirstDayOfMonth(new Date(2014, 8, 1))
|
| 22 | * //=> true
|
| 23 | */
|
| 24 | export declare function isFirstDayOfMonth(
|
| 25 | date: DateArg<Date> & {},
|
| 26 | options?: IsFirstDayOfMonthOptions | undefined,
|
| 27 | ): boolean;
|