Skip to content

Latest commit

 

History

History
40 lines (26 loc) · 872 Bytes

README.md

File metadata and controls

40 lines (26 loc) · 872 Bytes
Raw

Capacitor plugin for an easy compass using the native device sensors

Install

npm install capacitor-native-compass
npx cap sync

API

getCurrentHeading()

getCurrentHeading() => Promise<{ value: number; }>

Returns the current compass heading in degrees. On iOS, the heading is updated in the background, and the latest value is returned. On Android, the heading is calculated when the method is called. Not implemented on Web.

Returns: Promise<{ value: number; }>