1234567891011121314151617181920212223242526272829 |
- import type { ContextOptions, DateArg } from "./types.js";
- /**
- * The {@link isSameYear} function options.
- */
- export interface IsSameYearOptions extends ContextOptions<Date> {}
- /**
- * @name isSameYear
- * @category Year Helpers
- * @summary Are the given dates in the same year?
- *
- * @description
- * Are the given dates in the same year?
- *
- * @param laterDate - The first date to check
- * @param earlierDate - The second date to check
- * @param options - An object with options
- *
- * @returns The dates are in the same year
- *
- * @example
- * // Are 2 September 2014 and 25 September 2014 in the same year?
- * const result = isSameYear(new Date(2014, 8, 2), new Date(2014, 8, 25))
- * //=> true
- */
- export declare function isSameYear(
- laterDate: DateArg<Date> & {},
- earlierDate: DateArg<Date> & {},
- options?: IsSameYearOptions | undefined,
- ): boolean;
|