aric/temporal-hijri
1
0
Fork 0
mirror of https://github.com/acamarata/temporal-hijri.git synced 2026-06-30 19:04:29 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

style: fix prettier table formatting in wiki

Browse source
This commit is contained in:
Aric Camarata 2026-03-08 17:30:55 -04:00
parent 69b08f5971
commit f0e2985849
3 changed files with 42 additions and 42 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
.wiki/API-Reference.md
View file

@ -36,7 +36,7 @@ Accepts any engine registered via hijri-core's `registerCalendar()`. The calenda
## `UaqCalendar`
```typescript
new UaqCalendar()
new UaqCalendar();
```
Wraps the `uaq` engine from hijri-core. Calendar ID: `"hijri-uaq"`.
@ -46,7 +46,7 @@ Wraps the `uaq` engine from hijri-core. Calendar ID: `"hijri-uaq"`.
## `FcnaCalendar`
```typescript
new FcnaCalendar()
new FcnaCalendar();
```
Wraps the `fcna` engine from hijri-core. Calendar ID: `"hijri-fcna"`.
@ -60,7 +60,7 @@ All methods are available on `HijriCalendar`, `UaqCalendar`, and `FcnaCalendar`.
### Field accessors
| Method | Signature | Returns | Notes |
|---|---|---|---|
| ----------- | ----------------------------- | ---------------------- | ----------- |
| `year` | `(date: PlainDate) => number` | Hijri year | |
| `month` | `(date: PlainDate) => number` | Hijri month (1-12) | |
| `monthCode` | `(date: PlainDate) => string` | `"M01"` – `"M12"` | Zero-padded |
@ -69,7 +69,7 @@ All methods are available on `HijriCalendar`, `UaqCalendar`, and `FcnaCalendar`.
### Year and month metrics
| Method | Signature | Returns | Notes |
|---|---|---|---|
| -------------- | ------------------------------ | ---------------------- | ---------------------------- |
| `daysInMonth` | `(date: PlainDate) => number` | 29 or 30 | Varies by month and calendar |
| `daysInYear` | `(date: PlainDate) => number` | 354 or 355 | Sum of all 12 months |
| `monthsInYear` | `(date: PlainDate) => number` | Always 12 | |
@ -78,7 +78,7 @@ All methods are available on `HijriCalendar`, `UaqCalendar`, and `FcnaCalendar`.
### Week and day position
| Method | Signature | Returns | Notes |
|---|---|---|---|
| ------------ | ----------------------------- | ------------------ | --------------------- |
| `dayOfWeek` | `(date: PlainDate) => number` | 1-7 (Mon=1, Sun=7) | ISO weekday |
| `dayOfYear` | `(date: PlainDate) => number` | 1-354 or 1-355 | Within the Hijri year |
| `weekOfYear` | `(date: PlainDate) => number` | 1-51 | `ceil(dayOfYear / 7)` |
@ -87,7 +87,7 @@ All methods are available on `HijriCalendar`, `UaqCalendar`, and `FcnaCalendar`.
### Construction from fields
| Method | Signature | Returns |
|---|---|---|
| --------------------- | ---------------------------------------------------------- | -------------------- |
| `dateFromFields` | `(fields: {year, month, day}, options?) => PlainDate` | ISO `PlainDate` |
| `yearMonthFromFields` | `(fields: {year, month}, options?) => PlainYearMonth` | ISO `PlainYearMonth` |
| `monthDayFromFields` | `(fields: {month, day, year?}, options?) => PlainMonthDay` | ISO `PlainMonthDay` |
@ -125,7 +125,7 @@ Computes the difference between two dates. When `largestUnit` is `'years'` or `'
### Other
| Method | Signature | Returns |
|---|---|---|
| ------------- | -------------------------------------- | ------------------- |
| `mergeFields` | `(fields, additionalFields) => Record` | Merged field object |
| `toString` | `() => string` | Calendar identifier |

2
.wiki/Architecture.md
View file

@ -114,7 +114,7 @@ hijri-core provides:
The package ships two formats from a single TypeScript source:
| File | Format | Usage |
|---|---|---|
| ------------------ | ----------------------- | --------------------------------------------------- |
| `dist/index.mjs` | ESM | `import { uaqCalendar } from 'temporal-hijri'` |
| `dist/index.cjs` | CommonJS | `const { uaqCalendar } = require('temporal-hijri')` |
| `dist/index.d.ts` | Type declarations (CJS) | TypeScript + CJS |

2
.wiki/Home.md
View file

@ -19,7 +19,7 @@ This package provides `UaqCalendar` and `FcnaCalendar` as plug-in calendar objec
## Calendar systems
| Calendar | ID | Description |
|---|---|---|
| ----------- | ------------ | ---------------------------------------------------------- |
| Umm al-Qura | `hijri-uaq` | Official Saudi calendar, table-driven, covers 1318-1500 AH |
| FCNA/ISNA | `hijri-fcna` | North American standard, astronomical new moon calculation |