/* eslint-disable eslint-comments/no-unlimited-disable */
/* eslint-disable */
// @ts-nocheck

import { toDate } from '../toDate/index.ts';
import type { ContextOptions, DateArg } from '../types.ts';

/**
 * The {@link getYear} function options.
 */
export interface GetYearOptions extends ContextOptions<Date> {}

/**
 * @name getYear
 * @category Year Helpers
 * @summary Get the year of the given date.
 *
 * @description
 * Get the year of the given date.
 *
 * @param date - The given date
 * @param options - An object with options
 *
 * @returns The year
 *
 * @example
 * // Which year is 2 July 2014?
 * const result = getYear(new Date(2014, 6, 2))
 * //=> 2014
 */
export function getYear(date: DateArg<Date> & {}, options?: GetYearOptions | undefined): number {
  return toDate(date, options?.in).getFullYear();
}

/* eslint-enable */