{"_id":"vue-browser-geolocation","_rev":"15-9731da7168896a24daf83476b381a49d","name":"vue-browser-geolocation","dist-tags":{"latest":"3.1.0"},"versions":{"0.0.1":{"name":"vue-browser-geolocation","version":"0.0.1","author":{"name":"Marco Boffo","email":"=20"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"},"./package.json":"./package.json"},"gitHead":"9cd0234d46d77cd3957a6f131f0de8ed3493610c","scripts":{"lint":"eslint .","test":"vitest run","build":"vite build","coverage":"vitest run --coverage","typecheck":"tsc --noEmit","test:watch":"vitest","prepublishOnly":"npm run typecheck && npm run test && npm run build"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:940a88b8-2dbc-41b0-883c-c2ee61d5707c"}},"repository":{"url":"git+https://github.com/scaccogatto/vue-geolocation.git","type":"git"},"_npmVersion":"11.17.0","description":"Tiny, type-safe Geolocation for Vue 3 — a reactive useGeolocation() composable and standalone Promise-based helpers.","directories":{},"sideEffects":false,"_nodeVersion":"24.17.0","_hasShrinkwrap":false,"devDependencies":{"vue":"^3.5.39","vite":"^8.1.0","jsdom":"^29.1.1","eslint":"^10.6.0","vitest":"^4.1.9","@eslint/js":"^10.0.1","typescript":"^6.0.3","@types/node":"^26.0.1","vite-plugin-dts":"^5.0.3","typescript-eslint":"^8.62.0","@vitest/coverage-v8":"^4.1.9"},"peerDependencies":{"vue":"^3.2.25"},"_npmOperationalInternal":{"tmp":"tmp/vue-browser-geolocation_3.0.0_1782646591163_0.6340378092634684","host":"s3://npm-registry-packages-npm-production"}},"3.0.1":{"name":"vue-browser-geolocation","version":"3.0.1","keywords":["vue","vue3","composition-api","typescript","vite","geolocation","gps","composable","navigator","coordinates"],"author":{"name":"Marco Boffo","email":"marcoboffo.waves@gmail.com"},"license":"MIT","_id":"vue-browser-geolocation@3.0.1","maintainers":[{"name":"marco-gatto-boffo","email":"marcoboffo.waves@gmail.com"}],"homepage":"https://github.com/scaccogatto/vue-geolocation#readme","bugs":{"url":"https://github.com/scaccogatto/vue-geolocation/issues"},"dist":{"shasum":"de6c0246bd3d399a82c001dd8e4644ea95931e20","tarball":"https://registry.npmjs.org/vue-browser-geolocation/-/vue-browser-geolocation-3.0.1.tgz","fileCount":7,"integrity":"sha512-+ikXPh2belsQTvFOvwp9yQLZ5g2bRh6PHwUcrOYDgmBH3zUe20BI9J2OTAswqhEklv1PSI/wbMjQwH79np2Mtw==","signatures":[{"sig":"MEQCIA2nJ2LkyRNnASril751aPAokvFbzalzYs50oDRbUP2vAiBTTknDxRE0CHJ66ovVLUXAWjL/TLfEUTd9YjC32crJLQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/vue-browser-geolocation@3.0.1","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"unpackedSize":17371},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.mjs","engines":{"node":">=20"},"exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"},"./package.json":"./package.json"},"gitHead":"0e3da6ec01c0af68fc961916705875691d268d88","scripts":{"lint":"eslint .","test":"vitest run","build":"vite build","coverage":"vitest run --coverage","typecheck":"tsc --noEmit","test:watch":"vitest","prepublishOnly":"npm run typecheck && npm run test && npm run build"},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:940a88b8-2dbc-41b0-883c-c2ee61d5707c"}},"repository":{"url":"git+https://github.com/scaccogatto/vue-geolocation.git","type":"git"},"_npmVersion":"11.17.0","description":"Tiny, type-safe Geolocation for Vue 3 — a reactive useGeolocation() composable and standalone Promise-based helpers.","directories":{},"sideEffects":false,"_nodeVersion":"24.17.0","_hasShrinkwrap":false,"devDependencies":{"vue":"^3.5.39","vite":"^8.1.0","jsdom":"^29.1.1","eslint":"^10.6.0","vitest":"^4.1.9","@eslint/js":"^10.0.1","typescript":"^6.0.3","@types/node":"^26.0.1","vite-plugin-dts":"^5.0.3","typescript-eslint":"^8.62.0","@vitest/coverage-v8":"^4.1.9"},"peerDependencies":{"vue":"^3.2.25"},"_npmOperationalInternal":{"tmp":"tmp/vue-browser-geolocation_3.0.1_1782648184809_0.5172287503981656","host":"s3://npm-registry-packages-npm-production"}},"3.1.0":{"name":"vue-browser-geolocation","version":"3.1.0","description":"Tiny, type-safe Geolocation for Vue 3 — a reactive useGeolocation() composable and standalone Promise-based helpers.","author":{"name":"Marco Boffo","email":"marcoboffo.waves@gmail.com"},"repository":{"type":"git","url":"git+https://github.com/scaccogatto/vue-geolocation.git"},"bugs":{"url":"https://github.com/scaccogatto/vue-geolocation/issues"},"homepage":"https://github.com/scaccogatto/vue-geolocation#readme","keywords":["vue","vue3","composition-api","typescript","vite","geolocation","gps","composable","navigator","coordinates"],"license":"MIT","type":"module","sideEffects":false,"main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"},"./package.json":"./package.json"},"scripts":{"build":"vite build","typecheck":"tsc --noEmit","test":"vitest run","test:watch":"vitest","coverage":"vitest run --coverage","lint":"eslint .","prepublishOnly":"npm run typecheck && npm run test && npm run build"},"peerDependencies":{"vue":"^3.2.25"},"devDependencies":{"@eslint/js":"^10.0.1","@types/node":"^26.0.1","@vitest/coverage-v8":"^4.1.9","eslint":"^10.6.0","jsdom":"^29.1.1","typescript":"^6.0.3","typescript-eslint":"^8.62.0","vite":"^8.1.0","vite-plugin-dts":"^5.0.3","vitest":"^4.1.9","vue":"^3.5.39"},"engines":{"node":">=20"},"gitHead":"bf4611bfabd457feb29a5917884aa47cc09b102a","_id":"vue-browser-geolocation@3.1.0","_nodeVersion":"24.18.0","_npmVersion":"12.0.1","dist":{"integrity":"sha512-5LDh6EEpDvHIXQ3Z8xcij0N2sZxY+kho8GVX/6aoeQKYe4cRJsoRTb1MWPwwi7xr8FEJ29mHoONm/4L50dQ6cQ==","shasum":"166d866b1207a623dbd482a3de940fcb8d1d16a1","tarball":"https://registry.npmjs.org/vue-browser-geolocation/-/vue-browser-geolocation-3.1.0.tgz","fileCount":7,"unpackedSize":20131,"attestations":{"url":"https://registry.npmjs.org/-/npm/v1/attestations/vue-browser-geolocation@3.1.0","provenance":{"predicateType":"https://slsa.dev/provenance/v1"}},"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEYCIQDKDonT4+G7WJoxaXaQCz6+z9HZOSZIZ5Q/jR1lrxzahQIhALjW4d4Kg6JKZoei9jgsPobWyvx3/OlbATwsjHz0iHQZ"}]},"_npmUser":{"name":"GitHub Actions","email":"npm-oidc-no-reply@github.com","trustedPublisher":{"id":"github","oidcConfigId":"oidc:940a88b8-2dbc-41b0-883c-c2ee61d5707c"}},"directories":{},"maintainers":[{"name":"marco-gatto-boffo","email":"marcoboffo.waves@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/vue-browser-geolocation_3.1.0_1784292559199_0.23562971453769022"},"_hasShrinkwrap":false}},"time":{"created":"2017-03-31T10:40:29.095Z","modified":"2026-07-17T12:49:19.690Z","0.0.1":"2017-03-31T10:40:29.095Z","1.0.0":"2018-03-09T08:59:57.102Z","1.0.1":"2018-03-09T09:13:46.666Z","1.0.2":"2018-05-23T06:53:11.002Z","1.1.1":"2018-05-23T10:40:16.415Z","1.2.0":"2018-05-29T06:43:41.779Z","1.5.0":"2018-07-20T08:38:22.227Z","1.8.0":"2019-05-13T12:52:35.015Z","3.0.0":"2026-06-28T11:36:31.321Z","3.0.1":"2026-06-28T12:03:04.944Z","3.1.0":"2026-07-17T12:49:19.347Z"},"bugs":{"url":"https://github.com/scaccogatto/vue-geolocation/issues"},"author":{"name":"Marco Boffo","email":"marcoboffo.waves@gmail.com"},"license":"MIT","homepage":"https://github.com/scaccogatto/vue-geolocation#readme","keywords":["vue","vue3","composition-api","typescript","vite","geolocation","gps","composable","navigator","coordinates"],"repository":{"type":"git","url":"git+https://github.com/scaccogatto/vue-geolocation.git"},"description":"Tiny, type-safe Geolocation for Vue 3 — a reactive useGeolocation() composable and standalone Promise-based helpers.","maintainers":[{"name":"marco-gatto-boffo","email":"marcoboffo.waves@gmail.com"}],"readme":"# vue-browser-geolocation\n\n> Tiny, type-safe Geolocation for Vue 3 — a reactive `useGeolocation()` composable and standalone Promise-based helpers.\n\n[![npm version](https://img.shields.io/npm/v/vue-browser-geolocation.svg)](https://www.npmjs.com/package/vue-browser-geolocation)\n[![npm downloads](https://img.shields.io/npm/dm/vue-browser-geolocation)](https://www.npmjs.com/package/vue-browser-geolocation)\n[![CI](https://github.com/scaccogatto/vue-geolocation/actions/workflows/ci.yml/badge.svg)](https://github.com/scaccogatto/vue-geolocation/actions/workflows/ci.yml)\n[![minzipped size](https://img.shields.io/bundlephobia/minzip/vue-browser-geolocation)](https://bundlephobia.com/package/vue-browser-geolocation)\n[![license](https://img.shields.io/npm/l/vue-browser-geolocation.svg)](./LICENSE)\n\n- **Reactive composable** — `useGeolocation()` for `\n\n\n```\n\n`useGeolocation()` returns reactive refs and automatically clears the active watch when the component unmounts.\n\n| Field | Type | Description |\n| --- | --- | --- |\n| `coords` | `Ref` | Latest fix, `null` before the first one. |\n| `error` | `Ref` | Latest error (full object), `null` when fine. |\n| `isWatching` | `Ref` | Whether a watch is active. |\n| `getLocation(options?)` | `Promise` | One-shot fetch; updates `coords`/`error`. |\n| `watchLocation(options?)` | `number \\| undefined` | Starts a watch, returns its `watchID`. |\n| `clearWatch()` | `void` | Stops the active watch. |\n\n## Why not VueUse's `useGeolocation`?\n\n- Flat, typed `Coordinates` result (`{ lat, lng, accuracy, ... }`) instead of raw `GeolocationCoordinates`/`GeolocationPosition` fields spread across refs.\n- Typed error classes — `GeolocationUnsupportedError` and `GeolocationForcedRejectError` — so you can `instanceof`-check failure modes instead of parsing messages.\n- Built-in `forceReject` testing hook on `getLocation`/`watchLocation` to exercise failure paths without mocking `navigator.geolocation`.\n- Zero dependencies beyond the `vue` peer dependency — no `@vueuse/core` / `@vueuse/shared` pulled in.\n\n## Standalone functions\n\nEverything is also importable directly, no Vue instance required:\n\n```ts\nimport {\n getLocation,\n watchLocation,\n clearWatch,\n isSupported,\n} from 'vue-browser-geolocation'\n```\n\n## `Coordinates`\n\n```ts\ninterface Coordinates {\n lat: number\n lng: number\n altitude: number | null\n altitudeAccuracy: number | null\n accuracy: number\n heading: number | null\n speed: number | null\n}\n```\n\n## Distance helper\n\n`distanceBetween(a, b)` is a pure, Vue-free haversine helper returning the great-circle distance in meters between two points. It accepts this package's `Coordinates` or a raw `{ latitude, longitude }` pair, mixed or matched.\n\n```ts\nimport { distanceBetween } from 'vue-browser-geolocation'\n\ndistanceBetween(\n { latitude: 45.4642, longitude: 9.19 }, // Milan Duomo\n { latitude: 41.8902, longitude: 12.4922 }, // Rome Colosseum\n) // ≈ 477000 (meters)\n```\n\n## Options\n\nSee [`PositionOptions`](https://developer.mozilla.org/en-US/docs/Web/API/PositionOptions) — `{ enableHighAccuracy?, timeout?, maximumAge? }`.\n\n## Testing escape hatch\n\n`getLocation` and `watchLocation` accept a trailing `forceReject` flag. When `true`, the promise rejects immediately with a `GeolocationForcedRejectError`, letting you exercise failure paths without touching the real device API:\n\n```ts\nawait getLocation({}, true) // rejects\nawait watchLocation({}, undefined, true) // rejects\n```\n\n## Migrating from v2 (plugin API)\n\nv3 drops the `VueGeolocation` plugin and the `$getLocation / $watchLocation / $clearLocationWatch` global properties — use `useGeolocation()` or the standalone functions directly.\n\n## Migrating from v1 (Vue 2)\n\nv2/v3 target **Vue 3 only**. Breaking changes from v1:\n\n| v1 (Vue 2) | v3 (Vue 3) |\n| --- | --- |\n| `Vue.use(VueGeolocation)` | use `useGeolocation()` composable |\n| `reject(error.message)` (string) | `reject(error)` — full `GeolocationPositionError`; read `error.code` |\n| `$watchLocation()` resolved once | `watchLocation(options, onUpdate)` resolves with `{ watchID, coordinates }` and streams via `onUpdate` ([#15](https://github.com/scaccogatto/vue-geolocation/issues/15)) |\n| no composable | reactive `useGeolocation()` |\n| plain JS, no types | TypeScript, ships `.d.ts` |\n\nIf you cannot migrate to Vue 3 yet, stay on `vue-browser-geolocation@1.8.0`.\n\n## License\n\n[MIT](./LICENSE) © Marco Boffo\n","readmeFilename":"README.md"}