mirror of
https://github.com/acamarata/qibla.git
synced 2026-07-02 03:40:41 +00:00
a59756bd07
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.
46 lines
880 B
Markdown
46 lines
880 B
Markdown
[**@acamarata/qibla v1.1.1**](../README.md)
|
|
|
|
***
|
|
|
|
[@acamarata/qibla](../README.md) / qiblaGreatCircle
|
|
|
|
# Function: qiblaGreatCircle()
|
|
|
|
> **qiblaGreatCircle**(`lat`, `lng`, `steps?`): \[`number`, `number`\][]
|
|
|
|
Defined in: [index.ts:98](https://github.com/acamarata/qibla/blob/1546cd5c71a68dd73136e918b6f3f7f195fb5cc7/src/index.ts#L98)
|
|
|
|
Great-circle waypoints from [lat, lng] to the Ka'bah.
|
|
|
|
Uses the Slerp (spherical linear interpolation) formula. Useful for
|
|
drawing Qibla direction lines on maps.
|
|
|
|
## Parameters
|
|
|
|
### lat
|
|
|
|
`number`
|
|
|
|
Origin latitude in decimal degrees.
|
|
|
|
### lng
|
|
|
|
`number`
|
|
|
|
Origin longitude in decimal degrees.
|
|
|
|
### steps?
|
|
|
|
`number` = `120`
|
|
|
|
Number of segments (default: 120, producing 121 points).
|
|
|
|
## Returns
|
|
|
|
\[`number`, `number`\][]
|
|
|
|
Array of [latitude, longitude] pairs in degrees.
|
|
|
|
## Throws
|
|
|
|
If latitude is outside [-90, 90] or longitude outside [-180, 180].
|