aric/date-fns-hijri
1
0
Fork 0
mirror of https://github.com/acamarata/date-fns-hijri.git synced 2026-06-30 18:54:25 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
date-fns-hijri/.github/wiki/api/functions/addHijriYears.md

725 B
Raw Blame History

date-fns-hijri v1.0.1

date-fns-hijri / addHijriYears

Function: addHijriYears()

addHijriYears(date, years, options?): Date

Defined in: src/index.ts:293

Add a number of Hijri years to a Gregorian date.

If the resulting year has a shorter Ramadan (or any month) than the original day, the day is clamped to the last day of that month.

Parameters

date

Date

years

number

options?

ConversionOptions

Returns

Date

Throws

If the resulting Hijri date is outside the supported range.