qibla/.github/wiki/api/functions/compassName.md

27 lines
682 B
Markdown

[**@acamarata/qibla v1.1.1**](../README.md)
***
[@acamarata/qibla](../README.md) / compassName
# Function: compassName()
> **compassName**(`bearing`): `"North"` \| `"Northeast"` \| `"East"` \| `"Southeast"` \| `"South"` \| `"Southwest"` \| `"West"` \| `"Northwest"`
Defined in: [index.ts:80](https://github.com/acamarata/qibla/blob/a59756bd074a18a3c9cea4311d135cfb23a5ec7d/src/index.ts#L80)
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.).