| Documentation

HijriDate ▸
- Static members
- .now
- .today
- .yesterday
- .tomorrow
- Instance members
- #constructor
- #constructor
- #constructor
- #constructor
- #year
- #year
- #addDay
- #addDays
- #addHours
- #addMinutes
- #addSeconds
- #addMilliseconds
- #subtractDays
- #subtractDay
- #subtractHours
- #subtractMinutes
- #subtractSeconds
- #subtractMilliseconds
- #updateProxy
- #toGregorian
- #format
- #ignoreTime
- #clone
- #is
- #isToday
- #isYesterday
- #isTomorrow

Need help reading this?

HijriDate

The class which handles Hijri 🌙 instances

new HijriDate()

Example

new HijriDate(); //now
new HijriDate(1438, 12, 10) ; // يوم عيد الأضحى لسنة ١٤٣٨
new HijriDate(1438,7, 20, 18, 50, 44, 333); //  Monday Rajab 20 1438 18:50:44
new HijriDate({year:1355, hours:17}); // Tue Muharram 01 1355 17:00:00
new HijriDate(1484408713014);


new HijriDate().toGregorian(); //  === new Date();
new Date().toHijri(); //  === new HijriDate();

Static Members

▸ now()

TODO

now()

▸ today()

TODO

today()

▸ yesterday()

TODO

yesterday()

▸ tomorrow()

TODO

tomorrow()

Instance Members

▸ constructor(time)

constructor(time: number)

Parameters

time (number) numeric value of the specified date as the number of milliseconds since Shawwal 23, 1389, 00:00:00 UTC (January 1, 1970, 00:00:00 UTC)

Example

new HijriDate(1435454346342) // Sunday Ramadan 12 1436 04:19:06

▸ constructor(date, format = 'yyyy/mm/dd')

constructor(date: string, format: string?)

Parameters

date (string) stringified date

format

(string?
            = 'yyyy/mm/dd')

a compatible format with the date passed as string in the 1ˢᵗ argument.

Example

new HijriDate('10-09-1538', 'dd-mm-yyyy'); // Thu Rmdn 10 1538 00:00:00
new HijriDate('100 years since 04-1348','100 years since mm-yyyy' ); // Wed Rab2 01 1338 00:00:00

▸ constructor(dateProps)

constructor(dateProps: Object)

Parameters

dateProps (Object) literal object contains date properties .

Name	Description
dateProps.year `number`	the year is required .
dateProps.month `number?` (default `1`)	[ 1, 12 ] range .
dateProps.date `number?` (default `1`)	the date of the month🌔 ∈ {1, 30} .
dateProps.hours `number?` (default `0`)	⏰ ∈ {0, 23} .
dateProps.minutes `number?` (default `0`)	🕔 ∈ {0,59} .
dateProps.seconds `number?` (default `0`)	🕰 ∈ {0,59} .
dateProps.milliseconds `number?` (default `0`)	🕰 ∈ {0,999} .

Example

new HijriDate({year: 1430, minutes: 54}) // 01-01-1430 00:54:00
new HijriDate({year: 1504, hours: 17, seconds:44}) // 01-01-1504 17:00:44

▸ constructor(year, month, date = 1, hours = 0, minutes = 0, seconds = 0, number)

constructor(year: number, month: number, date: number?, hours: number?, minutes: number?, seconds: number?, number: any)

Parameters

year (number) the hijri year .

month (number) [ 1, 12 ] range .

date

(number?
            = 1)

the date of the month🌔 ∈ {1, 30} .

hours

(number?
            = 0)

⏰ ∈ {0, 23} .

minutes

(number?
            = 0)

🕔 ∈ {0,59} .

seconds

(number?
            = 0)

🕰 ∈ {0,59} .

number (any) 0] 🕰 ∈ {0,999} .

Example

new HijriDate(1450, 3) ; //Sun Rabee1 01 1450 00:00:00
new HijriDate(1450, 3, 5) ; //Thu Rabee1 05 1450 00:00:00
new HijriDate(1450, 3, 5, 17) ; //Thu Rabee1 05 1450 17:00:00
new HijriDate(1450, 3, 5, 16, 44) ; //Thu Rabee1 05 1450 16:44:00
new HijriDate(1450, 3, 5, 16, 44, 58) ; //Thu Rabee1 05 1450 16:44:58

▸ year

Get the year

year

Returns

number: the year

▸ year

Set the year

year

Parameters

newYear (number) year modifier of the instance.

Returns

undefined: nothing

Example

const d1 = new HijriDate(1399, 10, 25);
d1.year += 2;
assertEqual(d1.year === 1401);

▸ addDay()

This method adds 1 day (24 hours) to the instance.

addDay(): HijriDate

Returns

HijriDate: the instance itself after adding 1 day.

▸ addDays(days)

This method adds n day(s) to the instance.

addDays(days: number): HijriDate

Parameters

days (number) number of days to add .

Returns

HijriDate: the instance itself after adding n day(s).

▸ addHours(n)

TODO

addHours(n: any)

Parameters

n (any)

▸ addMinutes(n)

TODO

addMinutes(n: any)

Parameters

n (any)

▸ addSeconds(n)

TODO

addSeconds(n: any)

Parameters

n (any)

▸ addMilliseconds(n)

TODO

addMilliseconds(n: any)

Parameters

n (any)

▸ subtractDays(days)

TODO

subtractDays(days: any)

Parameters

days (any)

▸ subtractDay()

TODO

subtractDay()

▸ subtractHours(n)

TODO

subtractHours(n: any)

Parameters

n (any)

▸ subtractMinutes(n)

TODO

subtractMinutes(n: any)

Parameters

n (any)

▸ subtractSeconds(n)

TODO

subtractSeconds(n: any)

Parameters

n (any)

▸ subtractMilliseconds(n)

TODO

subtractMilliseconds(n: any)

Parameters

n (any)

▸ updateProxy()

TODO

updateProxy()

▸ toGregorian()

TODO

toGregorian()

▸ format(mask, options)

TODO

format(mask: any, options: any)

Parameters

mask (any)

options (any)

▸ ignoreTime()

TODO

ignoreTime()

▸ clone()

TODO

clone()

▸ is()

TODO

is()

▸ isToday()

TODO

isToday()

▸ isYesterday()

TODO

isYesterday()

▸ isTomorrow()

TODO

isTomorrow()