date-fns-hijri/.github/wiki/api/functions/addHijriYears.md
Aric Camarata e8ade1f9c4 docs: add TypeDoc API generation (typedoc@0.28.19 + typedoc-plugin-markdown@4.11.0)
Add typedoc and typedoc-plugin-markdown as devDependencies. Add typedoc.json config
targeting src/index.ts with markdown output to .github/wiki/api. Add docs script to
package.json. Generate initial API reference pages.

Part of T-E8-03 — TypeDoc automation for all 12 JS/TS packages.
2026-05-30 16:41:59 -04:00

725 B

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.