{"_id":"@abennouna/capacitor-native-compass","_rev":"4-cc64b45efac407b76ba05c9e1c7b1778","name":"@abennouna/capacitor-native-compass","dist-tags":{"latest":"0.0.6"},"versions":{"0.0.4":{"name":"@abennouna/capacitor-native-compass","version":"0.0.4","keywords":["capacitor","plugin","native"],"author":{"name":"Kai Niebes"},"license":"GPL-3.0-or-later","_id":"@abennouna/capacitor-native-compass@0.0.4","maintainers":[{"name":"abennouna","email":"abennouna@gmail.com"}],"contributors":[{"name":"Abdelaziz Bennouna","email":"abennouna@github.com"}],"homepage":"https://github.com/abennouna/capacitor-native-compass.git#readme","bugs":{"url":"https://github.com/abennouna/capacitor-native-compass.git/issues"},"dist":{"shasum":"d908d1e95a06ed48fd45b37cbf132e6b45d2f78e","tarball":"https://registry.npmjs.org/@abennouna/capacitor-native-compass/-/capacitor-native-compass-0.0.4.tgz","fileCount":31,"integrity":"sha512-mazLsWVpWHdI78Z8YPqLPJQUlM/cC/VN9MFVOtSQC/xwRXj6y7mWpSBP+yEvbIhbKhB59khTV0QutCfuxujICg==","signatures":[{"sig":"MEYCIQCQaZCQ8YwO9fNUBqokylNVtRgYqwoHdGaNrJ2PdxAmGgIhAOisZzA4PhX5j/7m7cGf1lqrB0ff2T8MaanjSa1L0ZGj","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":94691},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"e44d79a5af14355a7cbd54ece17c9d274ae1e10c","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api NativeCompassPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"abennouna","email":"abennouna@gmail.com"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/abennouna/capacitor-native-compass.git.git","type":"git"},"_npmVersion":"10.8.3","description":"Capacitor plugin for an easy compass using the native device sensors","directories":{},"_nodeVersion":"22.9.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","rimraf":"^3.0.2","rollup":"^2.32.0","prettier":"~2.3.0","swiftlint":"^1.0.1","typescript":"~4.1.5","@capacitor/ios":"^6.0.0","@capacitor/core":"^6.0.0","@capacitor/docgen":"^0.0.18","@capacitor/android":"^6.0.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"~1.0.2","@ionic/prettier-config":"^1.0.1","@ionic/swiftlint-config":"^1.1.2"},"peerDependencies":{"@capacitor/core":"^6.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-native-compass_0.0.4_1737721320893_0.24020923649443304","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.0.5":{"name":"@abennouna/capacitor-native-compass","version":"0.0.5","keywords":["capacitor","plugin","native"],"author":{"name":"Kai Niebes"},"license":"GPL-3.0-or-later","_id":"@abennouna/capacitor-native-compass@0.0.5","maintainers":[{"name":"abennouna","email":"abennouna@gmail.com"}],"contributors":[{"name":"Abdelaziz Bennouna","email":"abennouna@github.com"}],"homepage":"https://github.com/abennouna/capacitor-native-compass.git#readme","bugs":{"url":"https://github.com/abennouna/capacitor-native-compass.git/issues"},"dist":{"shasum":"8b09efb2e5dd63d75b56c9a67aec5047f45c544b","tarball":"https://registry.npmjs.org/@abennouna/capacitor-native-compass/-/capacitor-native-compass-0.0.5.tgz","fileCount":30,"integrity":"sha512-WOLGhHq9elzKGX4jAqxDawHv9nAnpvbh5GZq94uT/9RfJcCa07VCLRmcAWhVckkByW/jTULPiRbHU0EEmI/a8g==","signatures":[{"sig":"MEQCIF1HI6APW89JjhfW0P+WrxiCKlN3Scw/bJbsX+J6cg0vAiBEJ5klbrm1HvOaVTA2fMvHN9ltJrvfEqhQVnCN5HN5dQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":94151},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"fa4f83355e3855306305132eb6d218d7d556c7e2","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api NativeCompassPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"abennouna","email":"abennouna@gmail.com"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/abennouna/capacitor-native-compass.git.git","type":"git"},"_npmVersion":"10.8.3","description":"Capacitor plugin for an easy compass using the native device sensors","directories":{},"_nodeVersion":"22.9.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","rimraf":"^3.0.2","rollup":"^2.32.0","prettier":"~2.3.0","swiftlint":"^1.0.1","typescript":"~4.1.5","@capacitor/ios":"^6.0.0","@capacitor/core":"^6.0.0","@capacitor/docgen":"^0.0.18","@capacitor/android":"^6.0.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"~1.0.2","@ionic/prettier-config":"^1.0.1","@ionic/swiftlint-config":"^1.1.2"},"peerDependencies":{"@capacitor/core":"^6.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-native-compass_0.0.5_1737722904206_0.3882945327524312","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."},"0.0.6":{"name":"@abennouna/capacitor-native-compass","version":"0.0.6","keywords":["capacitor","plugin","native"],"author":{"name":"Kai Niebes"},"license":"GPL-3.0-or-later","_id":"@abennouna/capacitor-native-compass@0.0.6","maintainers":[{"name":"abennouna","email":"abennouna@gmail.com"}],"contributors":[{"name":"Abdelaziz Bennouna","email":"abennouna@github.com"}],"homepage":"https://github.com/abennouna/capacitor-native-compass.git#readme","bugs":{"url":"https://github.com/abennouna/capacitor-native-compass.git/issues"},"dist":{"shasum":"56d2cb1894339bf058e156eb0f20669634bf50c4","tarball":"https://registry.npmjs.org/@abennouna/capacitor-native-compass/-/capacitor-native-compass-0.0.6.tgz","fileCount":31,"integrity":"sha512-jtZOY+vsfnBisAFqbabk2VNJ+ZN6yO2gWNCWMo5YXRJjkBXu35R0OVdFJVDdPrXb+XoBdqTnFVGdV65XbmTWzQ==","signatures":[{"sig":"MEUCID7SKG892zJ/jQCqyRSd5RNO6hnY+IG+Js6kmyH9yG1YAiEAxSyrlhNhyDxHIoYvIRhNlbLj6vxIAskXWZNUqwmM+cM=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":94721},"main":"dist/plugin.cjs.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","module":"dist/esm/index.js","gitHead":"7e52f5ad8c8a54563afe12dc7b5adb5c7635327e","scripts":{"fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","docgen":"docgen --api NativeCompassPlugin --output-readme README.md --output-json dist/docs.json","eslint":"eslint . --ext ts","verify":"npm run verify:ios && npm run verify:android && npm run verify:web","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:web":"npm run build","prepublishOnly":"npm run build","verify:android":"cd android && ./gradlew clean build test && cd .."},"_npmUser":{"name":"abennouna","email":"abennouna@gmail.com"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"swiftlint":"@ionic/swiftlint-config","repository":{"url":"git+https://github.com/abennouna/capacitor-native-compass.git.git","type":"git"},"_npmVersion":"10.8.3","description":"Capacitor plugin for an easy compass using the native device sensors","directories":{},"_nodeVersion":"22.9.0","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.57.0","rimraf":"^3.0.2","rollup":"^2.32.0","prettier":"~2.3.0","swiftlint":"^1.0.1","typescript":"~4.1.5","@capacitor/ios":"^6.0.0","@capacitor/core":"^6.0.0","@capacitor/docgen":"^0.0.18","@capacitor/android":"^6.0.0","@ionic/eslint-config":"^0.4.0","prettier-plugin-java":"~1.0.2","@ionic/prettier-config":"^1.0.1","@ionic/swiftlint-config":"^1.1.2"},"peerDependencies":{"@capacitor/core":"^6.0.0"},"_npmOperationalInternal":{"tmp":"tmp/capacitor-native-compass_0.0.6_1737723261424_0.6412814183234314","host":"s3://npm-registry-packages-npm-production"},"deprecated":"Package no longer supported. Contact Support at https://www.npmjs.com/support for more info."}},"time":{"created":"2025-01-24T12:22:00.774Z","modified":"2026-01-30T11:37:03.325Z","0.0.4":"2025-01-24T12:22:01.083Z","0.0.5":"2025-01-24T12:48:24.445Z","0.0.6":"2025-01-24T12:54:21.721Z"},"bugs":{"url":"https://github.com/abennouna/capacitor-native-compass.git/issues"},"author":{"name":"Kai Niebes"},"license":"GPL-3.0-or-later","homepage":"https://github.com/abennouna/capacitor-native-compass.git#readme","keywords":["capacitor","plugin","native"],"repository":{"url":"git+https://github.com/abennouna/capacitor-native-compass.git.git","type":"git"},"description":"Capacitor plugin for an easy compass using the native device sensors","contributors":[{"name":"Abdelaziz Bennouna","email":"abennouna@github.com"}],"maintainers":[{"name":"abennouna","email":"abennouna@gmail.com"}],"readme":"

\n \n

\n\nCapacitor plugin for an easy compass using the native device sensors.\n\n\n\n* [`getCurrentHeading()`](#getcurrentheading)\n\n\n\n## Install\n\n```bash\nnpm install @abennouna/capacitor-native-compass\nnpx cap sync\n```\n\n## API\n\n\n\n\n### getCurrentHeading()\n\n```typescript\ngetCurrentHeading() => Promise<{ value: number; }>\n```\n\nReturns the current compass heading in degrees.\nOn iOS, the heading is updated in the background, and the latest value is returned.\nOn Android, the heading is calculated when the method is called.\nNot implemented on Web.\n\n**Returns:** Promise<{ value: number; }>\n\n--------------------\n\n\n","readmeFilename":"README.md"}