src/formatters/formatYearDropdown.ts

import { type DateLib, defaultDateLib } from "../classes/DateLib.js";

/**
 * Formats the year for the dropdown option label.
 *
 * @param year The year to format.
 * @param dateLib The date library to use for formatting. Defaults to
 *   `defaultDateLib`.
 * @returns The formatted year as a string.
 * @group Formatters
 * @see https://daypicker.dev/docs/translation#custom-formatters
 */
export function formatYearDropdown(
  year: Date,
  dateLib: DateLib = defaultDateLib,
): string {
  return dateLib.format(year, "yyyy");
}

/**
 * @private
 * @deprecated Use `formatYearDropdown` instead.
 * @group Formatters
 */
export const formatYearCaption = formatYearDropdown;