{"_id":"@arvaintelligence/compass","_rev":"1-a70580ebbfca1bfd79b1a453a3d8a9f9","name":"@arvaintelligence/compass","dist-tags":{"latest":"1.0.4"},"versions":{"1.0.3":{"name":"@arvaintelligence/compass","version":"1.0.3","description":"Read from device sensors to extract true north azimuth","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"Arva Intelligence Mobile Team"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/arva-intelligence-mobile/arva-plugins.git"},"bugs":{"url":"https://github.com/arva-intelligence-mobile/arva-plugins/issues"},"keywords":["capacitor","plugin","native"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api ArvaCompassPlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build"},"devDependencies":{"@capacitor/android":"^5.0.0","@capacitor/core":"^5.0.0","@capacitor/docgen":"^0.0.18","@capacitor/ios":"^5.0.0","@ionic/eslint-config":"^0.3.0","@ionic/prettier-config":"^1.0.1","@ionic/swiftlint-config":"^1.1.2","eslint":"^7.11.0","prettier":"~2.3.0","prettier-plugin-java":"~1.0.2","rimraf":"^3.0.2","rollup":"^2.32.0","swiftlint":"^1.0.1","typescript":"~4.1.5"},"peerDependencies":{"@capacitor/core":"^5.0.0"},"prettier":"@ionic/prettier-config","swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"gitHead":"db00f67243e0826e00076bed701e42e1b27f05c6","homepage":"https://github.com/arva-intelligence-mobile/arva-plugins#readme","_id":"@arvaintelligence/compass@1.0.3","_nodeVersion":"16.20.0","_npmVersion":"9.6.7","dist":{"integrity":"sha512-ajTrc4W+HxbANRZDrwlNuQVJsfy4dCnjEZ7NOLyPJSf0AXJukKThfYrpQvgQxL6fuEMtkADrIrNvTfGjMe0ysg==","shasum":"a6b152bf0acab3cb7143e072a8be9961e0cf15b4","tarball":"https://registry.npmjs.org/@arvaintelligence/compass/-/compass-1.0.3.tgz","fileCount":27,"unpackedSize":33762,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCRZa66Qvk0uvACr9FnoPNFYgdI+iM6VRPcrymGtbqbgQIgGwr8nKggFovTAPJY2O6TV9susSJENFzgD0OIL/YHbn8="}]},"_npmUser":{"name":"andrew-lyons","email":"aslyons001@gmail.com"},"directories":{},"maintainers":[{"name":"andrew-lyons","email":"aslyons001@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/compass_1.0.3_1691086380892_0.462908476849778"},"_hasShrinkwrap":false},"1.0.4":{"name":"@arvaintelligence/compass","version":"1.0.4","description":"Read from device sensors to extract true north azimuth","main":"dist/plugin.cjs.js","module":"dist/esm/index.js","types":"dist/esm/index.d.ts","unpkg":"dist/plugin.js","author":{"name":"Arva Intelligence Mobile Team"},"license":"MIT","repository":{"type":"git","url":"git+https://github.com/arva-intelligence-mobile/arva-plugins.git"},"bugs":{"url":"https://github.com/arva-intelligence-mobile/arva-plugins/issues"},"keywords":["capacitor","plugin","native"],"scripts":{"verify":"npm run verify:ios && npm run verify:android && npm run verify:web","verify:ios":"cd ios && pod install && xcodebuild -workspace Plugin.xcworkspace -scheme Plugin -destination generic/platform=iOS && cd ..","verify:android":"cd android && ./gradlew clean build test && cd ..","verify:web":"npm run build","lint":"npm run eslint && npm run prettier -- --check && npm run swiftlint -- lint","fmt":"npm run eslint -- --fix && npm run prettier -- --write && npm run swiftlint -- --fix --format","eslint":"eslint . --ext ts","prettier":"prettier \"**/*.{css,html,ts,js,java}\"","swiftlint":"node-swiftlint","docgen":"docgen --api ArvaCompassPlugin --output-readme README.md --output-json dist/docs.json","build":"npm run clean && npm run docgen && tsc && rollup -c rollup.config.js","clean":"rimraf ./dist","watch":"tsc --watch","prepublishOnly":"npm run build"},"devDependencies":{"@capacitor/android":"^5.0.0","@capacitor/core":"^5.0.0","@capacitor/docgen":"^0.0.18","@capacitor/ios":"^5.0.0","@ionic/eslint-config":"^0.3.0","@ionic/prettier-config":"^1.0.1","@ionic/swiftlint-config":"^1.1.2","eslint":"^7.11.0","prettier":"~2.3.0","prettier-plugin-java":"~1.0.2","rimraf":"^3.0.2","rollup":"^2.32.0","swiftlint":"^1.0.1","typescript":"~4.1.5"},"peerDependencies":{"@capacitor/core":"^5.0.0"},"prettier":"@ionic/prettier-config","swiftlint":"@ionic/swiftlint-config","eslintConfig":{"extends":"@ionic/eslint-config/recommended"},"capacitor":{"ios":{"src":"ios"},"android":{"src":"android"}},"gitHead":"803a75afe0a8d063d8e2fb67a2638bffdbcbc0a9","homepage":"https://github.com/arva-intelligence-mobile/arva-plugins#readme","_id":"@arvaintelligence/compass@1.0.4","_nodeVersion":"16.20.0","_npmVersion":"lerna/7.1.4/node@v16.20.0+arm64 (darwin)","dist":{"integrity":"sha512-IPnQeDG48xBAP8HslqiVsUgOZ7OJsDMHbF69ctqckbAS53zHFjk3w/c12RoSaBTeRXItgxnibFt5WThO1n7D0Q==","shasum":"79073c7cd54ea7839380b523e52df83c3c6fcdd1","tarball":"https://registry.npmjs.org/@arvaintelligence/compass/-/compass-1.0.4.tgz","fileCount":27,"unpackedSize":33786,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDFXcQAoJpg93RBxX9tR1qHx68IV9NmWSfE4rZ2WCOi5AIhAIvlzU3nWy+Qmgjc86NqpOE2ILsYpihYTmyXZRAduXAL"}]},"_npmUser":{"name":"andrew-lyons","email":"aslyons001@gmail.com"},"directories":{},"maintainers":[{"name":"andrew-lyons","email":"aslyons001@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/compass_1.0.4_1691086523934_0.19739775799095938"},"_hasShrinkwrap":false}},"time":{"created":"2023-08-03T18:13:00.780Z","1.0.3":"2023-08-03T18:13:01.057Z","modified":"2023-08-03T18:15:24.361Z","1.0.4":"2023-08-03T18:15:24.247Z"},"maintainers":[{"name":"andrew-lyons","email":"aslyons001@gmail.com"}],"description":"Read from device sensors to extract true north azimuth","homepage":"https://github.com/arva-intelligence-mobile/arva-plugins#readme","keywords":["capacitor","plugin","native"],"repository":{"type":"git","url":"git+https://github.com/arva-intelligence-mobile/arva-plugins.git"},"author":{"name":"Arva Intelligence Mobile Team"},"bugs":{"url":"https://github.com/arva-intelligence-mobile/arva-plugins/issues"},"license":"MIT","readme":"# @arvaintelligence/compass\n\nRead from device sensors to extract true north azimuth\n\n## Install\n\n```bash\nnpm install @arvaintelligence/compass\nnpx cap sync\n```\n\n## API\n\n<docgen-index>\n\n* [`streamCompassHeading(...)`](#streamcompassheading)\n* [`stopCompassStream()`](#stopcompassstream)\n* [`readCompassHeading()`](#readcompassheading)\n* [Interfaces](#interfaces)\n* [Type Aliases](#type-aliases)\n\n</docgen-index>\n\n<docgen-api>\n<!--Update the source file JSDoc comments and rerun docgen to update the docs below-->\n\n### streamCompassHeading(...)\n\n```typescript\nstreamCompassHeading(options: StreamCompassOptions, callback: StreamCompassCallback) => Promise<void>\n```\n\n| Param          | Type                                                                    |\n| -------------- | ----------------------------------------------------------------------- |\n| **`options`**  | <code><a href=\"#streamcompassoptions\">StreamCompassOptions</a></code>   |\n| **`callback`** | <code><a href=\"#streamcompasscallback\">StreamCompassCallback</a></code> |\n\n--------------------\n\n\n### stopCompassStream()\n\n```typescript\nstopCompassStream() => Promise<BaseResponse>\n```\n\n**Returns:** <code>Promise&lt;<a href=\"#baseresponse\">BaseResponse</a>&gt;</code>\n\n--------------------\n\n\n### readCompassHeading()\n\n```typescript\nreadCompassHeading() => Promise<AzimuthResponse>\n```\n\n**Returns:** <code>Promise&lt;<a href=\"#azimuthresponse\">AzimuthResponse</a>&gt;</code>\n\n--------------------\n\n\n### Interfaces\n\n\n#### StreamCompassOptions\n\n| Prop           | Type                |\n| -------------- | ------------------- |\n| **`interval`** | <code>number</code> |\n\n\n#### AzimuthResponse\n\n| Prop                   | Type                |\n| ---------------------- | ------------------- |\n| **`trueNorthAzimuth`** | <code>number</code> |\n\n\n#### BaseResponse\n\n| Prop      | Type                 |\n| --------- | -------------------- |\n| **`ok`**  | <code>boolean</code> |\n| **`msg`** | <code>string</code>  |\n\n\n### Type Aliases\n\n\n#### StreamCompassCallback\n\n<code>(success: <a href=\"#azimuthresponse\">AzimuthResponse</a>, error?: any): void</code>\n\n</docgen-api>\n","readmeFilename":"README.md"}