timepiece/node_modules/date-fns/getDay.d.ts

23 lines
668 B
TypeScript
Raw Normal View History

2024-05-14 14:54:12 +00:00
/**
* @name getDay
* @category Weekday Helpers
* @summary Get the day of the week of the given date.
*
* @description
* Get the day of the week of the given date.
*
* @typeParam DateType - The `Date` type, the function operates on. Gets inferred from passed arguments. Allows to use extensions like [`UTCDate`](https://github.com/date-fns/utc).
*
* @param date - The given date
*
* @returns The day of week, 0 represents Sunday
*
* @example
* // Which day of the week is 29 February 2012?
* const result = getDay(new Date(2012, 1, 29))
* //=> 3
*/
export declare function getDay<DateType extends Date>(
date: DateType | number | string,
): number;