/* eslint-disable eslint-comments/no-unlimited-disable */ /* eslint-disable */ // @ts-nocheck import { differenceInCalendarDays } from '../differenceInCalendarDays/index.ts'; import { startOfYear } from '../startOfYear/index.ts'; import { toDate } from '../toDate/index.ts'; import type { ContextOptions, DateArg } from '../types.ts'; /** * The {@link getDayOfYear} function options. */ export interface GetDayOfYearOptions extends ContextOptions {} /** * @name getDayOfYear * @category Day Helpers * @summary Get the day of the year of the given date. * * @description * Get the day of the year of the given date. * * @param date - The given date * @param options - The options * * @returns The day of year * * @example * // Which day of the year is 2 July 2014? * const result = getDayOfYear(new Date(2014, 6, 2)) * //=> 183 */ export function getDayOfYear(date: DateArg & {}, options?: GetDayOfYearOptions | undefined): number { const _date = toDate(date, options?.in); const diff = differenceInCalendarDays(_date, startOfYear(_date)); const dayOfYear = diff + 1; return dayOfYear; } /* eslint-enable */