mirror of
https://github.com/acamarata/moment-hijri-plus.git
synced 2026-06-30 18:54:29 +00:00
No description
1e3044c859
- Add @typescript-eslint/parser and @typescript-eslint/eslint-plugin to devDependencies - Fix eslint.config.mjs: add files pattern and parserOptions.project for typed linting - Fix prettier formatting in src/index.ts and src/types.ts - Add coverage/ to .gitignore and untrack committed coverage artifacts - postbuild cp already handles dist/index.d.mts (verified) |
||
|---|---|---|
| .github | ||
| src | ||
| .editorconfig | ||
| .gitignore | ||
| .npmrc | ||
| .nvmrc | ||
| CHANGELOG.md | ||
| eslint.config.mjs | ||
| LICENSE | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| README.md | ||
| test-cjs.cjs | ||
| test.mjs | ||
| tsconfig.json | ||
| tsup.config.ts | ||
| typedoc.json | ||
moment-hijri-plus
Moment.js plugin for Hijri calendar conversion and formatting. Delegates all calendar logic to hijri-core, a zero-dependency Hijri engine with pluggable calendar support (Umm al-Qura and FCNA/ISNA).
Installation
pnpm add moment moment-hijri-plus hijri-core
Both moment and hijri-core are peer dependencies.
Quick Start
import moment from 'moment';
import installHijri from 'moment-hijri-plus';
installHijri(moment);
const m = moment(new Date(2023, 2, 23)); // 23 March 2023
m.toHijri(); // { hy: 1444, hm: 9, hd: 1 } (1 Ramadan 1444 AH)
m.formatHijri('iD iMMMM iYYYY AH'); // '1 Ramadan 1444 AH'
moment.fromHijri(1446, 1, 1); // moment for 7 July 2024
API Summary
Call installHijri(moment) once at startup to add these methods.
| Method | Returns | Description |
|---|---|---|
toHijri(options?) |
HijriDate | null |
Convert to Hijri date object |
hijriYear(options?) |
number | null |
Hijri year |
hijriMonth(options?) |
number | null |
Hijri month (1-12) |
hijriDay(options?) |
number | null |
Hijri day |
isValidHijri(options?) |
boolean |
True if date is within calendar range |
formatHijri(fmt, options?) |
string |
Format with Hijri tokens; non-Hijri tokens pass through |
moment.fromHijri(hy, hm, hd, options?) |
Moment |
Construct moment from Hijri date |
Pass { calendar: 'fcna' } to switch from the default Umm al-Qura calendar to FCNA/ISNA.
Full API reference, format token table, and examples are in the project wiki.
Note on Moment.js
Moment.js is in maintenance mode. For new projects, dayjs-hijri-plus offers the same Hijri support on Day.js. This package targets existing codebases already using Moment.js.
Related
- hijri-core: Hijri calendar engine used internally
- dayjs-hijri-plus: same API for Day.js
- luxon-hijri: same API for Luxon
- pray-calc: Islamic prayer time calculation
License
MIT. Copyright (c) 2026 Aric Camarata.