tauqeet-js 1.0.1 → 1.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +1 -1
- package/README.md +143 -88
- package/dist/index.cjs +1939 -1513
- package/dist/index.cjs.map +1 -0
- package/dist/index.d.cts +545 -284
- package/dist/index.d.ts +545 -284
- package/dist/index.js +1896 -1462
- package/dist/index.js.map +1 -0
- package/package.json +64 -51
package/LICENSE
CHANGED
package/README.md
CHANGED
|
@@ -1,88 +1,143 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
**
|
|
4
|
-
|
|
5
|
-
[](LICENSE)
|
|
6
|
+
[](https://www.typescriptlang.org/)
|
|
7
|
+
|
|
8
|
+
> 📖 **Interactive documentation & live API explorer:** [https://tauqeet-js.web.app](https://tauqeet-js.web.app)
|
|
9
|
+
|
|
10
|
+
`tauqeet-js` (تَوقِيت — Arabic for "timing") provides high-fidelity Islamic astronomical computation powered by a full VSOP87-derived solar ephemeris, lunar theory, and ΔT correction. It is modular by design — import only the feature you need.
|
|
11
|
+
|
|
12
|
+
---
|
|
13
|
+
|
|
14
|
+
## Table of Contents
|
|
15
|
+
|
|
16
|
+
- [Features](#features)
|
|
17
|
+
- [Prerequisites](#prerequisites)
|
|
18
|
+
- [Installation](#installation)
|
|
19
|
+
- [Quick Start](#quick-start)
|
|
20
|
+
- [Documentation](#documentation)
|
|
21
|
+
- [Modules Overview](#modules-overview)
|
|
22
|
+
- [License](#license)
|
|
23
|
+
- [Author](#author)
|
|
24
|
+
|
|
25
|
+
---
|
|
26
|
+
|
|
27
|
+
## Features
|
|
28
|
+
|
|
29
|
+
| Module | Capability |
|
|
30
|
+
|---|---|
|
|
31
|
+
| **Prayers** | Fajr, Sunrise, Ḍuḥā, Dhuhr, Asr, Maghrib, Isha with 8 built-in calculation methods |
|
|
32
|
+
| **Qibla** | Great-circle bearing, rhumb-line bearing, and distance to the Kaaba |
|
|
33
|
+
| **Moon** | Phase, illumination, age, lunar events, crescent visibility (Odeh / Yallop / HMNAO) |
|
|
34
|
+
| **Hijri** | Gregorian ↔ Hijri conversion via Civil, Conjunction, Visibility, or Umm al-Qura methods |
|
|
35
|
+
| **Solar Alignment** | Times when the sun aligns with the Qibla direction (useful for compass calibration) |
|
|
36
|
+
|
|
37
|
+
---
|
|
38
|
+
|
|
39
|
+
## Prerequisites
|
|
40
|
+
|
|
41
|
+
- **Node.js** ≥ 18
|
|
42
|
+
- **TypeScript** ≥ 5 (for source usage)
|
|
43
|
+
- ESM-first; CJS bundle also provided.
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## Installation
|
|
48
|
+
|
|
49
|
+
```bash
|
|
50
|
+
npm install tauqeet-js
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
> **Note:** The package is currently in active development. See [CONTRIBUTING.md](CONTRIBUTING.md) for building from source.
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
## Quick Start
|
|
58
|
+
|
|
59
|
+
### Prayer Times
|
|
60
|
+
|
|
61
|
+
```ts
|
|
62
|
+
import { calculatePrayerTimes, BUILT_IN_METHODS } from 'tauqeet-js';
|
|
63
|
+
|
|
64
|
+
// London, UK – today
|
|
65
|
+
const result = calculatePrayerTimes({
|
|
66
|
+
lat: 51.5074,
|
|
67
|
+
long: -0.1278,
|
|
68
|
+
timeZone: 'Europe/London',
|
|
69
|
+
method: 'MWL', // Muslim World League
|
|
70
|
+
madhab: 'Shafi',
|
|
71
|
+
});
|
|
72
|
+
|
|
73
|
+
console.log(result.fajr.local); // e.g. "03:41 AM"
|
|
74
|
+
console.log(result.dhuhr.local); // e.g. "01:05 PM"
|
|
75
|
+
console.log(result.isha.local); // e.g. "10:52 PM"
|
|
76
|
+
```
|
|
77
|
+
|
|
78
|
+
### Qibla Direction
|
|
79
|
+
|
|
80
|
+
```ts
|
|
81
|
+
import { getQiblaDirection } from 'tauqeet-js';
|
|
82
|
+
|
|
83
|
+
const qibla = getQiblaDirection({ latitude: 51.5074, longitude: -0.1278 });
|
|
84
|
+
console.log(`Bearing to Kaaba: ${qibla.bearing?.toFixed(2)}°`);
|
|
85
|
+
console.log(`Distance: ${qibla.distanceKm.toFixed(0)} km`);
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
### Moon Phase
|
|
89
|
+
|
|
90
|
+
```ts
|
|
91
|
+
import { getMoonPhase, getMoonAge } from 'tauqeet-js';
|
|
92
|
+
|
|
93
|
+
const phase = getMoonPhase(new Date());
|
|
94
|
+
console.log(`Phase: ${phase.phaseName}`); // e.g. "Waxing Crescent"
|
|
95
|
+
console.log(`Illumination: ${(phase.illuminatedFraction * 100).toFixed(1)}%`);
|
|
96
|
+
|
|
97
|
+
const age = getMoonAge(new Date());
|
|
98
|
+
console.log(`Moon age: ${age.ageDays.toFixed(1)} days`);
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Hijri Date Conversion
|
|
102
|
+
|
|
103
|
+
```ts
|
|
104
|
+
import { toHijri, HijriMethod, HIJRI_MONTH_NAMES } from 'tauqeet-js';
|
|
105
|
+
|
|
106
|
+
const hijri = toHijri(new Date(), HijriMethod.CIVIL);
|
|
107
|
+
console.log(`${hijri.day} ${HIJRI_MONTH_NAMES[hijri.month - 1]} ${hijri.year} AH`);
|
|
108
|
+
```
|
|
109
|
+
|
|
110
|
+
---
|
|
111
|
+
|
|
112
|
+
## Documentation
|
|
113
|
+
|
|
114
|
+
| File | Description |
|
|
115
|
+
|---|---|
|
|
116
|
+
| [API.md](API.md) | Complete API reference for all exported functions, types, and classes |
|
|
117
|
+
| [USAGE.md](USAGE.md) | Practical code guides with real-world examples |
|
|
118
|
+
| [MODULES.md](MODULES.md) | Architecture overview and module import guide |
|
|
119
|
+
| [CONTRIBUTING.md](CONTRIBUTING.md) | Build, test, and contribution guidelines |
|
|
120
|
+
|
|
121
|
+
For the most up-to-date, interactive reference visit **[https://tauqeet-js.web.app](https://tauqeet-js.web.app)**.
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## Modules Overview
|
|
126
|
+
|
|
127
|
+
```
|
|
128
|
+
tauqeet-js
|
|
129
|
+
├── prayers/ Prayer time engine (8 methods, high-latitude strategies)
|
|
130
|
+
├── qibla/ Qibla bearing & distance to Mecca
|
|
131
|
+
├── moon/ Moon phase, age, events, crescent visibility
|
|
132
|
+
├── hijri/ Gregorian ↔ Hijri calendar conversion
|
|
133
|
+
├── solar-alignment/ Sun-at-Qibla times
|
|
134
|
+
└── astronomy/ Internal ephemeris (VSOP87, lunar theory, ΔT) — private
|
|
135
|
+
```
|
|
136
|
+
|
|
137
|
+
See [MODULES.md](MODULES.md) for a detailed dependency graph and tree-shaking guide.
|
|
138
|
+
|
|
139
|
+
---
|
|
140
|
+
|
|
141
|
+
## License
|
|
142
|
+
|
|
143
|
+
[MIT](LICENSE) © Ghulam Hasnain
|