TypeScript SDK Reference

react-native-background-geolocation

capacitor-background-geolocation

cordova-background-geolocation-lt

Quick links

Section	Description
BackgroundGeolocation	Primary entry point — start/stop, events, config
AppConfig	Lifecycle, heartbeat, scheduler, notifications
HttpConfig	HTTP upload endpoint, batching, auth headers
GeoConfig	Accuracy, distance filter, stop detection
PersistenceConfig	SQLite storage, TTL, templates
LoggerConfig	Log levels, retention, debug mode

Use the nav sidebar to browse all classes, events, and types.