qibla/.github/wiki/api/functions/distanceKm.md
Aric Camarata a59756bd07 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

706 B

@acamarata/qibla v1.1.1


@acamarata/qibla / distanceKm

Function: distanceKm()

distanceKm(lat1, lng1, lat2, lng2): number

Defined in: index.ts:142

Haversine distance between two coordinate pairs.

Parameters

lat1

number

First point latitude in decimal degrees.

lng1

number

First point longitude in decimal degrees.

lat2

number

Second point latitude in decimal degrees.

lng2

number

Second point longitude in decimal degrees.

Returns

number

Distance in kilometers (spherical Earth approximation).