28 lines
701 B
TypeScript
28 lines
701 B
TypeScript
|
import type { ContextOptions, DateArg } from "./types.js";
|
||
|
|
/**
|
||
|
|
* The {@link getDayOfYear} function options.
|
||
|
|
*/
|
||
|
|
export interface GetDayOfYearOptions extends ContextOptions<Date> {}
|
||
|
|
/**
|
||
|
|
* @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 declare function getDayOfYear(
|
||
|
|
date: DateArg<Date> & {},
|
||
|
|
options?: GetDayOfYearOptions | undefined,
|
||
|
|
): number;
|