qibla/.github/wiki/api/functions/compassName.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

682 B

@acamarata/qibla v1.1.1


@acamarata/qibla / compassName

Function: compassName()

compassName(bearing): "North" | "Northeast" | "East" | "Southeast" | "South" | "Southwest" | "West" | "Northwest"

Defined in: index.ts:80

Full compass direction name for a bearing.

Parameters

bearing

number

Bearing in degrees (0-360).

Returns

"North" | "Northeast" | "East" | "Southeast" | "South" | "Southwest" | "West" | "Northwest"

Full direction name (North, Northeast, etc.).