registration

This commit is contained in:
User
2025-02-02 16:08:03 +03:00
parent 7f6495eb4d
commit 78afbaed71
6334 changed files with 196774 additions and 165754 deletions

View File

@@ -1,3 +1,8 @@
import type { ContextOptions, DateArg } from "./types.js";
/**
* The {@link isFirstDayOfMonth} function options.
*/
export interface IsFirstDayOfMonthOptions extends ContextOptions<Date> {}
/**
* @name isFirstDayOfMonth
* @category Month Helpers
@@ -6,10 +11,9 @@
* @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
* @param options - An object with options
*
* @returns The date is the first day of a month
*
* @example
@@ -17,6 +21,7 @@
* const result = isFirstDayOfMonth(new Date(2014, 8, 1))
* //=> true
*/
export declare function isFirstDayOfMonth<DateType extends Date>(
date: DateType | number | string,
export declare function isFirstDayOfMonth(
date: DateArg<Date> & {},
options?: IsFirstDayOfMonthOptions | undefined,
): boolean;