mirror of
https://github.com/acamarata/qibla.git
synced 2026-06-30 19:04:28 +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.
27 lines
616 B
Markdown
27 lines
616 B
Markdown
[**@acamarata/qibla v1.1.1**](../README.md)
|
|
|
|
***
|
|
|
|
[@acamarata/qibla](../README.md) / compassDir
|
|
|
|
# Function: compassDir()
|
|
|
|
> **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)
|
|
|
|
Eight-point compass abbreviation for a bearing.
|
|
|
|
## Parameters
|
|
|
|
### bearing
|
|
|
|
`number`
|
|
|
|
Bearing in degrees (0-360).
|
|
|
|
## Returns
|
|
|
|
`"N"` \| `"NE"` \| `"E"` \| `"SE"` \| `"S"` \| `"SW"` \| `"W"` \| `"NW"`
|
|
|
|
Two-letter compass abbreviation (N, NE, E, SE, S, SW, W, NW).
|