31 lines
650 B
JavaScript
31 lines
650 B
JavaScript
import { toDate } from "./toDate.js";
|
|
|
|
/**
|
|
* The {@link getDay} function options.
|
|
*/
|
|
|
|
/**
|
|
* @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.
|
|
*
|
|
* @param date - The given date
|
|
* @param options - The options
|
|
*
|
|
* @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 function getDay(date, options) {
|
|
return toDate(date, options?.in).getDay();
|
|
}
|
|
|
|
// Fallback for modularized imports:
|
|
export default getDay;
|