Skip to main content
Module

x/date_fns/getDay/index.ts

date-fns Deno package
Very Popular
Latest
File
import toDate from '../toDate/index.ts'import requiredArgs from '../_lib/requiredArgs/index.ts'
/** * @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. * * ### v2.0.0 breaking changes: * * - [Changes that are common for the whole library](https://github.com/date-fns/date-fns/blob/master/docs/upgradeGuide.md#Common-Changes). * * @param {Date|Number} date - the given date * @returns {0|1|2|3|4|5|6} the day of week, 0 represents Sunday * @throws {TypeError} 1 argument required * * @example * // Which day of the week is 29 February 2012? * const result = getDay(new Date(2012, 1, 29)) * //=> 3 */export default function getDay(dirtyDate: Date | number): number { requiredArgs(1, arguments)
const date = toDate(dirtyDate) const day = date.getDay() return day}