aric/qibla
1
0
Fork 0
mirror of https://github.com/acamarata/qibla.git synced 2026-06-30 19:04:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: refresh TypeDoc API output (T-E8-03 QA-A verify)

Browse source
This commit is contained in:
Aric Camarata 2026-05-30 17:48:46 -04:00
parent a59756bd07
commit ee782babdb
12 changed files with 12 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
.github/wiki/api/functions/compassDir.md vendored
View file

@ -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.

2
.github/wiki/api/functions/compassName.md vendored
View file

@ -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.

2
.github/wiki/api/functions/distanceKm.md vendored
View file

@ -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.

2
.github/wiki/api/functions/qiblaAngle.md vendored
View file

@ -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.

2
.github/wiki/api/functions/qiblaGreatCircle.md vendored
View file

@ -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.

2
.github/wiki/api/type-aliases/CompassAbbr.md vendored
View file

@ -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.

2
.github/wiki/api/type-aliases/CompassName.md vendored
View file

@ -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.

2
.github/wiki/api/variables/COMPASS_ABBR.md vendored
View file

@ -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.

2
.github/wiki/api/variables/COMPASS_NAMES.md vendored
View file

@ -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.

2
.github/wiki/api/variables/EARTH_RADIUS_KM.md vendored
View file

@ -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).

2
.github/wiki/api/variables/KAABA_LAT.md vendored
View file

@ -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).

2
.github/wiki/api/variables/KAABA_LNG.md vendored
View file

@ -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).