{"id":34555337,"url":"https://github.com/transistorsoft/background-geolocation-types","last_synced_at":"2026-05-27T00:32:21.644Z","repository":{"id":324092526,"uuid":"1093969535","full_name":"transistorsoft/background-geolocation-types","owner":"transistorsoft","description":"Shared typescript api for react-native-background-geolocation, capacitor-background-geolocation, cordova-background-geolocation","archived":false,"fork":false,"pushed_at":"2026-04-10T13:05:33.000Z","size":510,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2026-04-10T15:08:11.797Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/transistorsoft.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-11T04:41:02.000Z","updated_at":"2026-04-10T13:05:37.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/transistorsoft/background-geolocation-types","commit_stats":null,"previous_names":["transistorsoft/background-geolocation-types"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/transistorsoft/background-geolocation-types","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transistorsoft%2Fbackground-geolocation-types","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transistorsoft%2Fbackground-geolocation-types/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transistorsoft%2Fbackground-geolocation-types/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transistorsoft%2Fbackground-geolocation-types/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/transistorsoft","download_url":"https://codeload.github.com/transistorsoft/background-geolocation-types/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/transistorsoft%2Fbackground-geolocation-types/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33545458,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"ssl_error","status_checked_at":"2026-05-26T15:22:15.568Z","response_time":63,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-12-24T08:28:26.174Z","updated_at":"2026-05-27T00:32:21.627Z","avatar_url":"https://github.com/transistorsoft.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @transistorsoft/background-geolocation-types\n\nShared **TypeScript type definitions** and **generated API documentation** for Transistor Software’s Background Geolocation SDKs:\n\n- **React Native**\n- **Capacitor**\n- **Cordova**\n\nThis package centralizes all public TypeScript interfaces, enums, utility types, and TypeDoc‑generated documentation shared across platform SDKs.  \nIt contains **types only** — no runtime code.\n\n---\n\n## 📦 Installation\n\nInstall as a development dependency:\n\n```bash\nnpm install @transistorsoft/background-geolocation-types --save-dev\n```\n\n```bash\nyarn add -D @transistorsoft/background-geolocation-types\n```\n\n```bash\npnpm add -D @transistorsoft/background-geolocation-types\n```\n\n---\n\n## 🎯 Purpose\n\nThis package exists to:\n\n1. Provide **strict, shared TypeScript types** across all Background Geolocation SDKs.\n2. Serve as the source for **Typedoc documentation**.\n3. Ensure consistent API signatures across React Native, Capacitor, and Cordova.\n\nThis avoids duplication and keeps all platform SDKs perfectly in sync.\n\n---\n\n## 📘 Using the Types\n\nTypically, consuming SDKs re‑export all public types:\n\n```ts\nimport BackgroundGeolocation, {\n  Config,\n  GeoConfig,\n  HttpConfig,\n  PersistMode,\n  Location,\n  State\n} from '{{pluginName}}';\n```\n\nIf desired, types can also be imported directly:\n\n```ts\nimport type { Location, GeofenceEvent, PersistMode } \n  from '@transistorsoft/background-geolocation-types';\n```\n\n---\n\n## 📚 Documentation\n\nGenerate API docs using:\n\n```bash\npnpm run docs\n```\n\nThis runs TypeDoc with the custom Transistorsoft plugins:\n\n- **typedoc-plugin-templates**\n- **typedoc-plugin-gitlink**\n- **typedoc-plugin-mediaplayer**\n- **typedoc-plugin-site**\n\nDocs output to:\n\n```\n./docs\n```\n\n---\n\n## 🛠️ Development\n\nBuild the project:\n\n```bash\npnpm run clean \u0026\u0026 pnpm run build\n```\n\nWatch mode:\n\n```bash\npnpm run watch\n```\n\n---\n\n## 📁 Structure\n\n```\nbackground-geolocation-types/\n  ├── src/\n  ├── dist/\n  ├── docs/\n  ├── tools/\n  ├── typedoc.json\n  └── tsconfig.json\n```\n\n---\n\n## 🤝 Contributing\n\nContributions are welcome — especially improvements to TypeScript typings and documentation.\n\nPlease ensure:\n\n- No runtime logic is added — this package is **types only**.\n- Definitions remain platform‑agnostic.\n- Changes reflect the APIs of all supported SDKs.\n\n---\n\n## 📄 License\n\nCommercial license. See `LICENSE` for details.\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftransistorsoft%2Fbackground-geolocation-types","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftransistorsoft%2Fbackground-geolocation-types","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftransistorsoft%2Fbackground-geolocation-types/lists"}