aric/pray-calc

mirror of https://github.com/acamarata/pray-calc.git synced 2026-06-30 19:04:26 +00:00

Aric Camarata 4227afc2c3 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:58 -04:00

2.1 KiB

Raw Blame History

pray-calc v2.1.1

pray-calc / MethodDefinition

Interface: MethodDefinition

Defined in: types.ts:104

Internal record for a single traditional method definition.

Properties

fajrAngle

fajrAngle: number | null

Defined in: types.ts:115

Fajr depression angle in degrees. Null means the method uses a seasonal calculation (MSC) rather than a fixed angle.

id

id: string

Defined in: types.ts:106

Short identifier used as the Methods map key.

ishaAngle

ishaAngle: number | null

Defined in: types.ts:120

Isha depression angle in degrees. Null means the method uses a fixed-minute offset or seasonal calculation instead.

ishaMinutes?

optional ishaMinutes?: number

Defined in: types.ts:125

Fixed minutes after sunset for Isha. Overrides ishaAngle when set. UAQ uses 90 year-round; Qatar uses 90 as well.

name

name: string

Defined in: types.ts:108

Human-readable name.

region

region: string

Defined in: types.ts:110

Geographic region of primary use.

useMSC?

optional useMSC?: boolean

Defined in: types.ts:130

When true, the method uses the MSC seasonal algorithm for both Fajr and Isha.