aric/dayjs-hijri-plus
1
0
Fork 0
mirror of https://github.com/acamarata/dayjs-hijri-plus.git synced 2026-06-30 18:54:26 +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 862ee41be5
commit db42550d3f
2 changed files with 40 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

63
.wiki/API-Reference.md
View file

@ -20,14 +20,15 @@ Call `dayjs.extend` once, globally. After that, every Day.js instance has the pl
Convert the Day.js date to a Hijri date. Convert the Day.js date to a Hijri date.
**Signature:** **Signature:**
```ts ```ts
toHijri(opts?: ConversionOptions): HijriDate | null toHijri(opts?: ConversionOptions): HijriDate | null
``` ```
**Parameters:** **Parameters:**
| Name | Type | Default | Description | | Name | Type | Default | Description |
| --- | --- | --- | --- | | --------------- | -------- | ------- | ------------------------------------------------ |
| `opts.calendar` | `string` | `'uaq'` | Calendar engine id. Built-ins: `'uaq'`, `'fcna'` | | `opts.calendar` | `string` | `'uaq'` | Calendar engine id. Built-ins: `'uaq'`, `'fcna'` |
**Returns:** `{ hy: number, hm: number, hd: number }` or `null` if the date is outside the table range. **Returns:** `{ hy: number, hm: number, hd: number }` or `null` if the date is outside the table range.
@ -47,6 +48,7 @@ dayjs('2023-03-23').toHijri({ calendar: 'fcna' });
Check whether the date has a valid Hijri representation in the supported range. Check whether the date has a valid Hijri representation in the supported range.
**Signature:** **Signature:**
```ts ```ts
isValidHijri(opts?: ConversionOptions): boolean isValidHijri(opts?: ConversionOptions): boolean
``` ```
@ -58,6 +60,7 @@ Returns `false` for dates outside the coverage range, `true` otherwise.
### `.hijriYear(opts?)` ### `.hijriYear(opts?)`
**Signature:** **Signature:**
```ts ```ts
hijriYear(opts?: ConversionOptions): number | null hijriYear(opts?: ConversionOptions): number | null
``` ```
@ -69,6 +72,7 @@ Returns the Hijri year, or `null` if out of range.
### `.hijriMonth(opts?)` ### `.hijriMonth(opts?)`
**Signature:** **Signature:**
```ts ```ts
hijriMonth(opts?: ConversionOptions): number | null hijriMonth(opts?: ConversionOptions): number | null
``` ```
@ -80,6 +84,7 @@ Returns the Hijri month (1-12), or `null` if out of range.
### `.hijriDay(opts?)` ### `.hijriDay(opts?)`
**Signature:** **Signature:**
```ts ```ts
hijriDay(opts?: ConversionOptions): number | null hijriDay(opts?: ConversionOptions): number | null
``` ```
@ -93,36 +98,37 @@ Returns the Hijri day (1-30), or `null` if out of range.
Format the date using a mix of Hijri-specific tokens and standard Day.js tokens. Format the date using a mix of Hijri-specific tokens and standard Day.js tokens.
**Signature:** **Signature:**
```ts ```ts
formatHijri(formatStr: string, opts?: ConversionOptions): string formatHijri(formatStr: string, opts?: ConversionOptions): string
``` ```
**Parameters:** **Parameters:**
| Name | Type | Description | | Name | Type | Description |
| --- | --- | --- | | ----------- | ------------------- | ------------------------------------------------------------- |
| `formatStr` | `string` | Format string containing Hijri tokens, Day.js tokens, or both | | `formatStr` | `string` | Format string containing Hijri tokens, Day.js tokens, or both |
| `opts` | `ConversionOptions` | Optional calendar selection | | `opts` | `ConversionOptions` | Optional calendar selection |
Returns an empty string if the date is outside the supported range. Returns an empty string if the date is outside the supported range.
**Hijri tokens:** **Hijri tokens:**
| Token | Example | Description | | Token | Example | Description |
| --- | --- | --- | | ------- | ---------------- | -------------------------------- |
| `iYYYY` | `1444` | 4-digit Hijri year | | `iYYYY` | `1444` | 4-digit Hijri year |
| `iYY` | `44` | 2-digit Hijri year | | `iYY` | `44` | 2-digit Hijri year |
| `iMMMM` | `Ramadan` | Full month name | | `iMMMM` | `Ramadan` | Full month name |
| `iMMM` | `Ramadan` | Medium month name | | `iMMM` | `Ramadan` | Medium month name |
| `iMM` | `09` | Zero-padded month number | | `iMM` | `09` | Zero-padded month number |
| `iM` | `9` | Month number | | `iM` | `9` | Month number |
| `iDD` | `01` | Zero-padded day | | `iDD` | `01` | Zero-padded day |
| `iD` | `1` | Day number | | `iD` | `1` | Day number |
| `iEEEE` | `Yawm al-Khamis` | Full weekday name | | `iEEEE` | `Yawm al-Khamis` | Full weekday name |
| `iEEE` | `Kham` | Short weekday name | | `iEEE` | `Kham` | Short weekday name |
| `iE` | `5` | Weekday number (1=Sun ... 7=Sat) | | `iE` | `5` | Weekday number (1=Sun ... 7=Sat) |
| `ioooo` | `AH` | Era | | `ioooo` | `AH` | Era |
| `iooo` | `AH` | Era (same as ioooo) | | `iooo` | `AH` | Era (same as ioooo) |
Standard Day.js tokens pass through to `.format()` after Hijri token substitution. Standard Day.js tokens pass through to `.format()` after Hijri token substitution.
@ -146,6 +152,7 @@ dayjs('2023-03-23').formatHijri('iYYYY YYYY');
Construct a Day.js instance from a Hijri date. Construct a Day.js instance from a Hijri date.
**Signature:** **Signature:**
```ts ```ts
dayjs.fromHijri( dayjs.fromHijri(
hy: number, hy: number,
@ -157,11 +164,11 @@ dayjs.fromHijri(
**Parameters:** **Parameters:**
| Name | Type | Description | | Name | Type | Description |
| --- | --- | --- | | --------------- | -------- | ------------------------------------- |
| `hy` | `number` | Hijri year | | `hy` | `number` | Hijri year |
| `hm` | `number` | Hijri month (1-12) | | `hm` | `number` | Hijri month (1-12) |
| `hd` | `number` | Hijri day (1-30) | | `hd` | `number` | Hijri day (1-30) |
| `opts.calendar` | `string` | Calendar engine id (default: `'uaq'`) | | `opts.calendar` | `string` | Calendar engine id (default: `'uaq'`) |
**Throws:** `Error` if the Hijri date is invalid or outside the table range. **Throws:** `Error` if the Hijri date is invalid or outside the table range.
@ -180,9 +187,9 @@ dayjs.fromHijri(1444, 9, 1, { calendar: 'fcna' }).format('YYYY-MM-DD');
```ts ```ts
import type { import type {
HijriDate, // { hy: number, hm: number, hd: number } HijriDate, // { hy: number, hm: number, hd: number }
ConversionOptions, // { calendar?: string } ConversionOptions, // { calendar?: string }
CalendarSystem, // string alias for calendar ids CalendarSystem, // string alias for calendar ids
} from 'dayjs-hijri-plus'; } from 'dayjs-hijri-plus';
``` ```

10
.wiki/Architecture.md
View file

@ -87,11 +87,11 @@ The package ships a dual CJS/ESM build via tsup. Both `dayjs` and `hijri-core` a
Output: Output:
| File | Format | | File | Format |
| --- | --- | | ------------------ | ------------------------------- |
| `dist/index.cjs` | CommonJS (Node `require`) | | `dist/index.cjs` | CommonJS (Node `require`) |
| `dist/index.mjs` | ESM (`import`) | | `dist/index.mjs` | ESM (`import`) |
| `dist/index.d.ts` | TypeScript declarations for CJS | | `dist/index.d.ts` | TypeScript declarations for CJS |
| `dist/index.d.mts` | TypeScript declarations for ESM | | `dist/index.d.mts` | TypeScript declarations for ESM |
--- ---