From ee782babdb570685c48a3f10bdef41430619f78d Mon Sep 17 00:00:00 2001 From: Aric Camarata Date: Sat, 30 May 2026 17:48:46 -0400 Subject: [PATCH] docs: refresh TypeDoc API output (T-E8-03 QA-A verify) --- .github/wiki/api/functions/compassDir.md | 2 +- .github/wiki/api/functions/compassName.md | 2 +- .github/wiki/api/functions/distanceKm.md | 2 +- .github/wiki/api/functions/qiblaAngle.md | 2 +- .github/wiki/api/functions/qiblaGreatCircle.md | 2 +- .github/wiki/api/type-aliases/CompassAbbr.md | 2 +- .github/wiki/api/type-aliases/CompassName.md | 2 +- .github/wiki/api/variables/COMPASS_ABBR.md | 2 +- .github/wiki/api/variables/COMPASS_NAMES.md | 2 +- .github/wiki/api/variables/EARTH_RADIUS_KM.md | 2 +- .github/wiki/api/variables/KAABA_LAT.md | 2 +- .github/wiki/api/variables/KAABA_LNG.md | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/.github/wiki/api/functions/compassDir.md b/.github/wiki/api/functions/compassDir.md index f25610b..6bd52f2 100644 --- a/.github/wiki/api/functions/compassDir.md +++ b/.github/wiki/api/functions/compassDir.md @@ -8,7 +8,7 @@ > **compassDir**(`bearing`): `"N"` \| `"NE"` \| `"E"` \| `"SE"` \| `"S"` \| `"SW"` \| `"W"` \| `"NW"` -Defined in: [index.ts:68](https://github.com/acamarata/qibla/blob/1546cd5c71a68dd73136e918b6f3f7f195fb5cc7/src/index.ts#L68) +Defined in: [index.ts:68](https://github.com/acamarata/qibla/blob/a59756bd074a18a3c9cea4311d135cfb23a5ec7d/src/index.ts#L68) Eight-point compass abbreviation for a bearing. diff --git a/.github/wiki/api/functions/compassName.md b/.github/wiki/api/functions/compassName.md index 4f9a4f2..29e24b1 100644 --- a/.github/wiki/api/functions/compassName.md +++ b/.github/wiki/api/functions/compassName.md @@ -8,7 +8,7 @@ > **compassName**(`bearing`): `"North"` \| `"Northeast"` \| `"East"` \| `"Southeast"` \| `"South"` \| `"Southwest"` \| `"West"` \| `"Northwest"` -Defined in: [index.ts:80](https://github.com/acamarata/qibla/blob/1546cd5c71a68dd73136e918b6f3f7f195fb5cc7/src/index.ts#L80) +Defined in: [index.ts:80](https://github.com/acamarata/qibla/blob/a59756bd074a18a3c9cea4311d135cfb23a5ec7d/src/index.ts#L80) Full compass direction name for a bearing. diff --git a/.github/wiki/api/functions/distanceKm.md b/.github/wiki/api/functions/distanceKm.md index dfe0d99..4efc0dd 100644 --- a/.github/wiki/api/functions/distanceKm.md +++ b/.github/wiki/api/functions/distanceKm.md @@ -8,7 +8,7 @@ > **distanceKm**(`lat1`, `lng1`, `lat2`, `lng2`): `number` -Defined in: [index.ts:142](https://github.com/acamarata/qibla/blob/1546cd5c71a68dd73136e918b6f3f7f195fb5cc7/src/index.ts#L142) +Defined in: [index.ts:142](https://github.com/acamarata/qibla/blob/a59756bd074a18a3c9cea4311d135cfb23a5ec7d/src/index.ts#L142) Haversine distance between two coordinate pairs. diff --git a/.github/wiki/api/functions/qiblaAngle.md b/.github/wiki/api/functions/qiblaAngle.md index f279eac..fe464c2 100644 --- a/.github/wiki/api/functions/qiblaAngle.md +++ b/.github/wiki/api/functions/qiblaAngle.md @@ -8,7 +8,7 @@ > **qiblaAngle**(`lat`, `lng`): `number` -Defined in: [index.ts:46](https://github.com/acamarata/qibla/blob/1546cd5c71a68dd73136e918b6f3f7f195fb5cc7/src/index.ts#L46) +Defined in: [index.ts:46](https://github.com/acamarata/qibla/blob/a59756bd074a18a3c9cea4311d135cfb23a5ec7d/src/index.ts#L46) Qibla bearing in degrees clockwise from true north. diff --git a/.github/wiki/api/functions/qiblaGreatCircle.md b/.github/wiki/api/functions/qiblaGreatCircle.md index a8f9666..dd8c520 100644 --- a/.github/wiki/api/functions/qiblaGreatCircle.md +++ b/.github/wiki/api/functions/qiblaGreatCircle.md @@ -8,7 +8,7 @@ > **qiblaGreatCircle**(`lat`, `lng`, `steps?`): \[`number`, `number`\][] -Defined in: [index.ts:98](https://github.com/acamarata/qibla/blob/1546cd5c71a68dd73136e918b6f3f7f195fb5cc7/src/index.ts#L98) +Defined in: [index.ts:98](https://github.com/acamarata/qibla/blob/a59756bd074a18a3c9cea4311d135cfb23a5ec7d/src/index.ts#L98) Great-circle waypoints from [lat, lng] to the Ka'bah. diff --git a/.github/wiki/api/type-aliases/CompassAbbr.md b/.github/wiki/api/type-aliases/CompassAbbr.md index 2b7c734..8ddf6c6 100644 --- a/.github/wiki/api/type-aliases/CompassAbbr.md +++ b/.github/wiki/api/type-aliases/CompassAbbr.md @@ -8,6 +8,6 @@ > **CompassAbbr** = *typeof* [`COMPASS_ABBR`](../variables/COMPASS_ABBR.md)\[`number`\] -Defined in: [types.ts:26](https://github.com/acamarata/qibla/blob/1546cd5c71a68dd73136e918b6f3f7f195fb5cc7/src/types.ts#L26) +Defined in: [types.ts:26](https://github.com/acamarata/qibla/blob/a59756bd074a18a3c9cea4311d135cfb23a5ec7d/src/types.ts#L26) Compass abbreviation type. diff --git a/.github/wiki/api/type-aliases/CompassName.md b/.github/wiki/api/type-aliases/CompassName.md index cca8690..5d70fba 100644 --- a/.github/wiki/api/type-aliases/CompassName.md +++ b/.github/wiki/api/type-aliases/CompassName.md @@ -8,6 +8,6 @@ > **CompassName** = *typeof* [`COMPASS_NAMES`](../variables/COMPASS_NAMES.md)\[`number`\] -Defined in: [types.ts:29](https://github.com/acamarata/qibla/blob/1546cd5c71a68dd73136e918b6f3f7f195fb5cc7/src/types.ts#L29) +Defined in: [types.ts:29](https://github.com/acamarata/qibla/blob/a59756bd074a18a3c9cea4311d135cfb23a5ec7d/src/types.ts#L29) Compass full name type. diff --git a/.github/wiki/api/variables/COMPASS_ABBR.md b/.github/wiki/api/variables/COMPASS_ABBR.md index ed56c99..fcb365f 100644 --- a/.github/wiki/api/variables/COMPASS_ABBR.md +++ b/.github/wiki/api/variables/COMPASS_ABBR.md @@ -8,6 +8,6 @@ > `const` **COMPASS\_ABBR**: readonly \[`"N"`, `"NE"`, `"E"`, `"SE"`, `"S"`, `"SW"`, `"W"`, `"NW"`\] -Defined in: [types.ts:11](https://github.com/acamarata/qibla/blob/1546cd5c71a68dd73136e918b6f3f7f195fb5cc7/src/types.ts#L11) +Defined in: [types.ts:11](https://github.com/acamarata/qibla/blob/a59756bd074a18a3c9cea4311d135cfb23a5ec7d/src/types.ts#L11) Eight-point compass abbreviations. diff --git a/.github/wiki/api/variables/COMPASS_NAMES.md b/.github/wiki/api/variables/COMPASS_NAMES.md index 471c4b2..5ec77fb 100644 --- a/.github/wiki/api/variables/COMPASS_NAMES.md +++ b/.github/wiki/api/variables/COMPASS_NAMES.md @@ -8,6 +8,6 @@ > `const` **COMPASS\_NAMES**: readonly \[`"North"`, `"Northeast"`, `"East"`, `"Southeast"`, `"South"`, `"Southwest"`, `"West"`, `"Northwest"`\] -Defined in: [types.ts:14](https://github.com/acamarata/qibla/blob/1546cd5c71a68dd73136e918b6f3f7f195fb5cc7/src/types.ts#L14) +Defined in: [types.ts:14](https://github.com/acamarata/qibla/blob/a59756bd074a18a3c9cea4311d135cfb23a5ec7d/src/types.ts#L14) Eight-point compass full names. diff --git a/.github/wiki/api/variables/EARTH_RADIUS_KM.md b/.github/wiki/api/variables/EARTH_RADIUS_KM.md index 6c2cbe7..5aa61d3 100644 --- a/.github/wiki/api/variables/EARTH_RADIUS_KM.md +++ b/.github/wiki/api/variables/EARTH_RADIUS_KM.md @@ -8,6 +8,6 @@ > `const` **EARTH\_RADIUS\_KM**: `6371` = `6371` -Defined in: [types.ts:8](https://github.com/acamarata/qibla/blob/1546cd5c71a68dd73136e918b6f3f7f195fb5cc7/src/types.ts#L8) +Defined in: [types.ts:8](https://github.com/acamarata/qibla/blob/a59756bd074a18a3c9cea4311d135cfb23a5ec7d/src/types.ts#L8) Mean radius of the Earth in kilometers (WGS-84 volumetric mean). diff --git a/.github/wiki/api/variables/KAABA_LAT.md b/.github/wiki/api/variables/KAABA_LAT.md index 20c82c2..0f1cbdc 100644 --- a/.github/wiki/api/variables/KAABA_LAT.md +++ b/.github/wiki/api/variables/KAABA_LAT.md @@ -8,6 +8,6 @@ > `const` **KAABA\_LAT**: `21.422511` = `21.422511` -Defined in: [types.ts:2](https://github.com/acamarata/qibla/blob/1546cd5c71a68dd73136e918b6f3f7f195fb5cc7/src/types.ts#L2) +Defined in: [types.ts:2](https://github.com/acamarata/qibla/blob/a59756bd074a18a3c9cea4311d135cfb23a5ec7d/src/types.ts#L2) Latitude of the Ka'bah center, Masjid al-Haram, Mecca (degrees north). diff --git a/.github/wiki/api/variables/KAABA_LNG.md b/.github/wiki/api/variables/KAABA_LNG.md index f9ad549..d845c1f 100644 --- a/.github/wiki/api/variables/KAABA_LNG.md +++ b/.github/wiki/api/variables/KAABA_LNG.md @@ -8,6 +8,6 @@ > `const` **KAABA\_LNG**: `39.82615` = `39.82615` -Defined in: [types.ts:5](https://github.com/acamarata/qibla/blob/1546cd5c71a68dd73136e918b6f3f7f195fb5cc7/src/types.ts#L5) +Defined in: [types.ts:5](https://github.com/acamarata/qibla/blob/a59756bd074a18a3c9cea4311d135cfb23a5ec7d/src/types.ts#L5) Longitude of the Ka'bah center, Masjid al-Haram, Mecca (degrees east).