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
dayjs-hijri-plus/.github/wiki/api/interfaces/CalendarEngine.md
Aric Camarata 033ca47576 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

1.6 KiB
Raw Blame History

dayjs-hijri-plus v1.0.1

dayjs-hijri-plus / CalendarEngine

Interface: CalendarEngine

Defined in: node_modules/.pnpm/hijri-core@1.0.0/node_modules/hijri-core/dist/index.d.mts:13

Re-exported CalendarEngine interface from hijri-core. Use this type to implement custom calendar engines for registerCalendar.

Properties

id

readonly id: string

Defined in: node_modules/.pnpm/hijri-core@1.0.0/node_modules/hijri-core/dist/index.d.mts:14

Methods

daysInMonth()

daysInMonth(hy, hm): number

Defined in: node_modules/.pnpm/hijri-core@1.0.0/node_modules/hijri-core/dist/index.d.mts:19

Parameters

hy

number

hm

number

Returns

number

isValid()

isValid(hy, hm, hd): boolean

Defined in: node_modules/.pnpm/hijri-core@1.0.0/node_modules/hijri-core/dist/index.d.mts:18

Parameters

hy

number

hm

number

hd

number

Returns

boolean

toGregorian()

toGregorian(hy, hm, hd): Date | null

Defined in: node_modules/.pnpm/hijri-core@1.0.0/node_modules/hijri-core/dist/index.d.mts:17

Returns null for invalid or out-of-range input. Never throws.

Parameters

hy

number

hm

number

hd

number

Returns

Date | null

toHijri()

toHijri(date): HijriDate | null

Defined in: node_modules/.pnpm/hijri-core@1.0.0/node_modules/hijri-core/dist/index.d.mts:15

Parameters

date

Date

Returns

HijriDate | null