Skip to content
TaqwimTaqwim

Function: getDayInWeek()

@taqwim/core

@taqwim/core / getDayInWeek

getDayInWeek(hijriDate, options?): number

Defined in: packages/core/src/lib/getDayInWeek.ts:13

Returns the day of the week for a given Hijri date.

Parameters

Section titled “Parameters”

hijriDate

Section titled “hijriDate”

The Hijri date to get the day of the week for.

"" | ValidHijriDate

options?

Section titled “options?”

HijriCalendarSystemOptions

Returns

Section titled “Returns”

number

The day of the week as a number (0-6), where 0 represents Sunday, 1 represents Monday, and so on. Returns undefined if the provided Hijri date is invalid.