date-fns-hijri/.github/wiki/api/functions/isValidHijriDate.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

38 lines
674 B
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

[**date-fns-hijri v1.0.1**](../README.md)
***
[date-fns-hijri](../README.md) / isValidHijriDate
# Function: isValidHijriDate()
> **isValidHijriDate**(`hy`, `hm`, `hd`, `options?`): `boolean`
Defined in: [src/index.ts:62](https://github.com/acamarata/date-fns-hijri/blob/a86df7dc09266326214c15cbd459de48d21cea29/src/index.ts#L62)
Check whether a Hijri date is valid for the given calendar system.
Verifies that the year, month (112), and day (1daysInMonth) all exist
in the calendar's data table.
## Parameters
### hy
`number`
### hm
`number`
### hd
`number`
### options?
[`ConversionOptions`](../interfaces/ConversionOptions.md)
## Returns
`boolean`