@transistorsoft/background-geolocation-types 5.0.0-beta.3 → 5.0.0-beta.5

package/dist/core/api/CurrentPositionRequest.d.ts

@@ -1,44 +1,8 @@
-/**
- * Options provided to {@link BackgroundGeolocation.getCurrentPosition}.
- *
- * @example
- * ```typescript
- * let location = await BackgroundGeolocation.getCurrentPosition({
- *   timeout: 30,          // 30 second timeout to fetch location
- *   persist: true,        // Defaults to state.enabled
- *   maximumAge: 5000,     // Accept the last-known-location if not older than 5000 ms.
- *   desiredAccuracy: 10,  // Try to fetch a location with an accuracy of `10` meters.
- *   samples: 3,           // How many location samples to attempt.
- *   extras: {             // Custom meta-data.
- *     "route_id": 123
- *   }
- * });
- * ```
- * @category Primary API
- */
 export interface CurrentPositionRequest {
-    /**
-    * Sets the maximum number of location-samples to fetch before returning the best possible location to your `callback`.  Default is `3`.  Only the final Location will be persisted.
-    */
     samples?: number;
-    /**
-    * Sets the desired accuracy of location you're attempting to fetch. When a location having `accuracy <= desiredAccuracy` is retrieved, the plugin will stop sampling and immediately return that location. Defaults to your configured [[Config.stationaryRadius]].
-    */
     desiredAccuracy?: number;
-    /**
-    * Location-timeout in `seconds`.  Default: `30`.  If the timeout expires before a [[Location]] is retrieved, a [[LocationError]] will fire.
-    */
     timeout?: number;
-    /**
-    * Defaults to `true` when plugin is `enabled`; `false`, otherwise.  Set `false` to disable persisting the retrieved Location in the plugin's SQLite database.
-    */
     persist?: boolean;
-    /**
-    * Accept the last-recorded-location if no older than supplied value in `milliseconds`.  Default is `0`.
-    */
     maximumAge?: number;
-    /**
-    * Optional meta-data to attach to the location. These `extras` will be merged to the configured [[Config.extras]] and persisted / POSTed to your server (if you've configured a [[Config.url]].
-    */
     extras?: Record<string, any>;
 }

package/dist/core/api/DeviceSettings.d.ts

@@ -1,77 +1,14 @@
-/**
- * An object for redirecting a User to an Android device's settings screen from a {@link DeviceSettings} request.
- *
- * Contains meta-data about the device (`manufacturer`, `model`, `version`) and whether you’ve already shown this screen.
- *
- * @category Device
- */
 export interface DeviceSettingsRequest {
-    /** Device manufacturer (e.g., "Huawei", "Samsung"). */
     manufacturer: string;
-    /** Device model (e.g., "P40", "SM-G991B"). */
     model: string;
-    /** OS version string. */
     version: string;
-    /** Whether this screen has previously been shown. */
     seen: boolean;
-    /** Timestamp of when this screen was last shown. */
     lastSeenAt: Date;
-    /**
-     * The settings screen action to be shown.
-     * ⚠️ Set automatically by the native layer.
-     */
     action: string;
 }
-/**
- * Device Settings API (types-only).
- *
- * Provides an API to show Android & vendor-specific Battery / Power Management settings screens that can
- * affect performance of the Background Geolocation SDK on various devices.
- *
- * See: https://dontkillmyapp.com/
- *
- * @example
- * ```ts
- * // Is Android device ignoring battery optimizations?
- * const isIgnoring = await BackgroundGeolocation.deviceSettings.isIgnoringBatteryOptimizations();
- * if (!isIgnoring) {
- *   const req = await BackgroundGeolocation.deviceSettings.showIgnoreBatteryOptimizations();
- *   if (!req.seen) {
- *     const confirmed = await showMyConfirmDialog({ title: 'Settings request', text: 'Please disable battery optimizations' });
- *     if (confirmed) {
- *       await BackgroundGeolocation.deviceSettings.show(req);
- *     }
- *   }
- * }
- * ```
- * @category Device
- */
 export interface DeviceSettings {
-    /**
-     * Returns `true` if device is ignoring battery optimizations for your app.
-     *
-     * In most cases, the SDK performs normally with battery optimizations enabled.
-     */
     isIgnoringBatteryOptimizations(): Promise<boolean>;
-    /**
-     * Prepare a request to show Android’s *Ignore Battery Optimizations* settings screen.
-     *
-     * Does **not** immediately redirect — returns a {@link DeviceSettingsRequest} first so you can
-     * decide whether to prompt the user (eg: avoid annoying them if `seen === true`).
-     *
-     * ⚠️ On some devices/OS versions, this screen may not exist; callers should `catch` errors.
-     */
     showIgnoreBatteryOptimizations(): Promise<DeviceSettingsRequest>;
-    /**
-     * Prepare a request to show a vendor-specific “Power Manager” screen (Huawei, Xiaomi, Vivo, etc).
-     *
-     * Does **not** immediately redirect — returns a {@link DeviceSettingsRequest} first.
-     * Not all vendors/versions implement this screen; callers should `catch` errors.
-     */
     showPowerManager(): Promise<DeviceSettingsRequest>;
-    /**
-     * Execute a previously prepared {@link DeviceSettingsRequest} to actually show the screen.
-     * Resolves `true` if the redirect was attempted.
-     */
     show(request: DeviceSettingsRequest): Promise<boolean>;
 }

package/dist/core/api/Logger.d.ts

@@ -1,421 +1,21 @@
 import { SQLQueryOrder } from "../../enums/SQLQueryOrder";
-/**
- * Used for selecting a range of records from the SDK's log database.
- *
- * Used with:
- * - {@link Logger.getLog}
- * - {@link Logger.emailLog}
- * - {@link Logger.uploadLog}
- *
- * ```ts
- * // Constrain results between optional start/end dates using an SQLQuery
- * const log = await BackgroundGeolocation.logger.getLog({
- *   start: Date.parse("2019-10-21 13:00"),  // <-- optional HH:mm:ss
- *   end:   Date.parse("2019-10-22")
- * });
- *
- * // Or just a start date
- * const partial = await BackgroundGeolocation.logger.getLog({
- *   start: Date.parse("2019-10-21 13:00")
- * });
- *
- * // Or just an end date
- * await BackgroundGeolocation.logger.uploadLog("https://my.server.com/users/123/logs", {
- *   end: Date.parse("2019-10-21")
- * });
- *
- * // Select first 100 records from log (ascending)
- * const Logger = BackgroundGeolocation.logger;
- * await Logger.emailLog("foo@bar.com", {
- *   order: SQLQueryOrder.Asc,
- *   limit: 100
- * });
- *
- * // Select most recent 100 records from log (descending)
- * await Logger.emailLog("foo@bar.com", {
- *   order: SQLQueryOrder.Desc,
- *   limit: 100
- * });
- * ```
- *
- * @category Logger
- */
 export interface SQLQuery {
-    /**
-     * Start date of logs to select (unix timestamp in **milliseconds**).
-     */
     start?: number;
-    /**
-     * End date of logs to select (unix timestamp in **milliseconds**).
-     */
     end?: number;
-    /**
-     * Limit number of records returned.
-     */
     limit?: number;
-    /**
-     * Offset into the result set (for paging).
-     */
     offset?: number;
-    /**
-     * Sort order for results.
-     *
-     * - `SQLQueryOrder.Asc`  → ascending by time
-     * - `SQLQueryOrder.Desc` → descending by time
-     *
-     * Historically this corresponded to:
-     * - `1`  = ASC
-     * - `-1` = DESC
-     */
     order?: SQLQueryOrder;
 }
-/**
- * Logger API
- *
- * The Background Geolocation SDK includes powerful logging features for debugging location-tracking problems.  The SDK stores log-entries for a period of {@link LoggerConfig.logMaxDays} (default `3`).  The volume of logging events
- * inserted into the database is controlled via {@link LoggerConfig.logLevel}.
- *
- * For more information, see the 📘[Debugging Guide](github:wiki/Debugging).
- *
- * The `Logger` API is accessed via {@link BackgroundGeolocation.logger} property:
- *
- * @example
- * ```typescript
- * let Logger = BackgroundGeolocation.logger;
- * let log = await Logger.getLog();
- * ```
- *
- * ## Fetching the Logs:
- *
- * Logs can be fetched from the SDK in three ways:
- * 1.  [[getLog]]
- * 2.  [[emailLog]]
- * 3.  [[uploadLog]]
- *
- * ## Inserting your own log messages
- *
- * You can even insert your own log messages into the SDK's Log database using the following methods:
- *
- * | method       | logLevel | icon            |
- * |--------------|----------|-----------------|
- * |[[error]]     |`ERROR`   | ❗️              |
- * |[[warn]]      |`WARNING` | ⚠️              |
- * |[[debug]]     |`DEBUG`   | 🐞              |
- * |[[info]]      |`INFO`    | ℹ️              |
- * |[[notice]]    |`INFO`    | 🔵              |
- *
- * @example
- * ```typescript
- * let Logger = BackgroundGeolocation.logger;
- * BackgroundGeolocation.onLocation((location) => {
- *   Logger.debug("Location received in Javascript: " + location.uuid);
- * });
- * ```
- *
- * __Example Logs__
- *
- * ```
- * 09-19 11:12:18.716 ╔═════════════════════════════════════════════
- * 09-19 11:12:18.716 ║ BackgroundGeolocation Service started
- * 09-19 11:12:18.716 ╠═════════════════════════════════════════════
- * 09-19 11:12:18.723 [c.t.l.BackgroundGeolocationService d]
- * 09-19 11:12:18.723   ✅  Started in foreground
- * 09-19 11:12:18.737 [c.t.l.ActivityRecognitionService a]
- * 09-19 11:12:18.737   🎾  Start activity updates: 10000
- * 09-19 11:12:18.761 [c.t.l.BackgroundGeolocationService k]
- * 09-19 11:12:18.761   🔴  Stop heartbeat
- * 09-19 11:12:18.768 [c.t.l.BackgroundGeolocationService a]
- * 09-19 11:12:18.768   🎾  Start heartbeat (60)
- * 09-19 11:12:18.778 [c.t.l.BackgroundGeolocationService a]
- * 09-19 11:12:18.778   🔵  setPace: null → false
- * 09-19 11:12:18.781 [c.t.l.adapter.TSConfig c] ℹ️   Persist config
- * 09-19 11:12:18.794 [c.t.locationmanager.util.b a]
- * 09-19 11:12:18.794   ℹ️  LocationAuthorization: Permission granted
- * 09-19 11:12:18.842 [c.t.l.http.HttpService flush]
- * 09-19 11:12:18.842 ╔═════════════════════════════════════════════
- * 09-19 11:12:18.842 ║ HTTP Service
- * 09-19 11:12:18.842 ╠═════════════════════════════════════════════
- * 09-19 11:12:19.000 [c.t.l.BackgroundGeolocationService onActivityRecognitionResult] still (100%)
- * 09-19 11:12:21.314 [c.t.l.l.SingleLocationRequest$2 onLocationResult]
- * 09-19 11:12:21.314 ╔═════════════════════════════════════════════
- * 09-19 11:12:21.314 ║ SingleLocationRequest: 1
- * 09-19 11:12:21.314 ╠═════════════════════════════════════════════
- * 09-19 11:12:21.314 ╟─ 📍  Location[fused 45.519239,-73.617058 hAcc=15]999923706055 vAcc=2 sAcc=??? bAcc=???
- * 09-19 11:12:21.327 [c.t.l.l.TSLocationManager onSingleLocationResult]
- * 09-19 11:12:21.327   🔵  Acquired motionchange position, isMoving: false
- * 09-19 11:12:21.342 [c.t.l.l.TSLocationManager a] 15.243
- * 09-19 11:12:21.405 [c.t.locationmanager.data.a.c persist]
- * 09-19 11:12:21.405   ✅  INSERT: bca5acc8-e358-4d8f-827f-b8c0d556b7bb
- * 09-19 11:12:21.423 [c.t.l.http.HttpService flush]
- * 09-19 11:12:21.423 ╔═════════════════════════════════════════════
- * 09-19 11:12:21.423 ║ HTTP Service
- * 09-19 11:12:21.423 ╠═════════════════════════════════════════════
- * 09-19 11:12:21.446 [c.t.locationmanager.data.a.c first]
- * 09-19 11:12:21.446   ✅  Locked 1 records
- * 09-19 11:12:21.454 [c.t.l.http.HttpService a]
- * 09-19 11:12:21.454   🔵  HTTP POST: bca5acc8-e358-4d8f-827f-b8c0d556b7bb
- * 09-19 11:12:22.083 [c.t.l.http.HttpService$a onResponse]
- * 09-19 11:12:22.083   🔵  Response: 200
- * 09-19 11:12:22.100 [c.t.locationmanager.data.a.c destroy]
- * 09-19 11:12:22.100   ✅  DESTROY: bca5acc8-e358-4d8f-827f-b8c0d556b7bb
- * 09-19 11:12:55.226 [c.t.l.BackgroundGeolocationService onActivityRecognitionResult] still (100%)
- * ```
- *
- * @category Logger
- */
 export interface Logger {
-    /** Sort ascending when querying logs. Mirrors {@link Logger.ORDER_ASC} constant. */
     readonly ORDER_ASC: 1;
-    /** Sort descending when querying logs. Mirrors {@link Logger.ORDER_DESC} constant. */
     readonly ORDER_DESC: -1;
-    /**
-    * Inserts a debug log message into the SDK's log database
-    *
-    * @example
-    * ```typescript
-    * BackgroundGeolocation.logger.debug("This is a debug message");
-    * ```
-    * &nbsp;
-    * ```
-    * D TSLocationManager: [c.t.l.logger.TSLog log] This is a debug message
-    * ```
-    */
     debug(message: string): void;
-    /**
-    * Inserts an "error" log message into the SDK's log database
-    *
-    * @example
-    * ```typescript
-    * BackgroundGeolocation.logger.error("Something BAD");
-    * ```
-    * &nbsp;
-    * ```
-    * E TSLocationManager: [c.t.l.logger.TSLog log]
-    * E TSLocationManager: ‼ Something BAD
-    * ```
-    */
     error(message: string): void;
-    /**
-    * Inserts a "warning" log message into the SDK's log database
-    *
-    * @example
-    * ```typescript
-    * BackgroundGeolocation.logger.warn("Something WEIRD");
-    * ```
-    * &nbsp;
-    *
-    * ```
-    * E TSLocationManager: [c.t.l.logger.TSLog log]
-    * E TSLocationManager: ⚠️  Something WEIRD
-    * ```
-    */
     warn(message: string): void;
-    /**
-    * Inserts an "info" log message into the SDK's log database
-    *
-    * @example
-    * ```typescript
-    * BackgroundGeolocation.logger.info("Something informative");
-    * ```
-    * &nbsp;
-    * ```
-    * E TSLocationManager: [c.t.l.logger.TSLog log]
-    * I TSLocationManager:   ℹ️  Something informative
-    * ```
-    */
     info(message: string): void;
-    /**
-    * Inserts a "notice" log message into the SDK's log database
-    *
-    * @example
-    * ```typescript
-    * BackgroundGeolocation.logger.notice("A Notice");
-    * ```
-    * &nbsp;
-    * ```
-    * E TSLocationManager: [c.t.l.logger.TSLog log]
-    * I TSLocationManager:   🔵  A Notice
-    * ```
-    */
     notice(message: string): void;
-    /**
-    * Returns the records from log database as a `String`.  Provide an optional {@link SQLQuery} to contrain results between dates.
-    *
-    * Depending on the configured {@link LoggerConfig.logLevel}, the plugin can store an *immense* amount of helpful logging information for debugging location-tracking
-    * problems.
-    *
-    * __ℹ️ See also:__
-    * - {@link LoggerConfig.logMaxDays} (default `3` days)
-    * - {@link LoggerConfig.logLevel} (default {@link LogLevel.Off})
-    * - {@link emailLog}
-    * - {@link uploadLog}
-    * - {@link getLog}
-    * - 📘[Debugging Guide](github:wiki/Debugging)
-    *
-    * @example
-    * ```typescript
-    * BackgroundGeolocation.logger.getLog().then((log) => {
-    *   // Warning:  this string could be several megabytes.
-    *   console.log("[log] success: ", log);
-    * });
-    *
-    * // Or constrain results by providing a SQLQuery
-    * let Logger = BackgroundGeolocation.logger;
-    *
-    * let log = await Logger.getLog({
-    *   start: Date.parse("2019-09-19 11:12"),
-    *   end: Date.parse("2019-09-19 11:13"),
-    *   order: Logger.ORDER_ASC,
-    *   limit: 100
-    * });
-    * ```
-    *
-    * ```
-    * 09-19 11:12:18.716 ╔═════════════════════════════════════════════
-    * 09-19 11:12:18.716 ║ BackgroundGeolocation Service started
-    * 09-19 11:12:18.716 ╠═════════════════════════════════════════════
-    * 09-19 11:12:18.723 [c.t.l.BackgroundGeolocationService d]
-    * 09-19 11:12:18.723   ✅  Started in foreground
-    * 09-19 11:12:18.737 [c.t.l.ActivityRecognitionService a]
-    * 09-19 11:12:18.737   🎾  Start activity updates: 10000
-    * 09-19 11:12:18.761 [c.t.l.BackgroundGeolocationService k]
-    * 09-19 11:12:18.761   🔴  Stop heartbeat
-    * 09-19 11:12:18.768 [c.t.l.BackgroundGeolocationService a]
-    * 09-19 11:12:18.768   🎾  Start heartbeat (60)
-    * 09-19 11:12:18.778 [c.t.l.BackgroundGeolocationService a]
-    * 09-19 11:12:18.778   🔵  setPace: null → false
-    * 09-19 11:12:18.781 [c.t.l.adapter.TSConfig c] ℹ️   Persist config
-    * 09-19 11:12:18.794 [c.t.locationmanager.util.b a]
-    * 09-19 11:12:18.794   ℹ️  LocationAuthorization: Permission granted
-    * 09-19 11:12:18.842 [c.t.l.http.HttpService flush]
-    * 09-19 11:12:18.842 ╔═════════════════════════════════════════════
-    * 09-19 11:12:18.842 ║ HTTP Service
-    * 09-19 11:12:18.842 ╠═════════════════════════════════════════════
-    * 09-19 11:12:19.000 [c.t.l.BackgroundGeolocationService onActivityRecognitionResult] still (100%)
-    * 09-19 11:12:21.314 [c.t.l.l.SingleLocationRequest$2 onLocationResult]
-    * 09-19 11:12:21.314 ╔═════════════════════════════════════════════
-    * 09-19 11:12:21.314 ║ SingleLocationRequest: 1
-    * 09-19 11:12:21.314 ╠═════════════════════════════════════════════
-    * 09-19 11:12:21.314 ╟─ 📍  Location[fused 45.519239,-73.617058 hAcc=15]999923706055 vAcc=2 sAcc=??? bAcc=???
-    * 09-19 11:12:21.327 [c.t.l.l.TSLocationManager onSingleLocationResult]
-    * 09-19 11:12:21.327   🔵  Acquired motionchange position, isMoving: false
-    * 09-19 11:12:21.342 [c.t.l.l.TSLocationManager a] 15.243
-    * 09-19 11:12:21.405 [c.t.locationmanager.data.a.c persist]
-    * 09-19 11:12:21.405   ✅  INSERT: bca5acc8-e358-4d8f-827f-b8c0d556b7bb
-    * 09-19 11:12:21.423 [c.t.l.http.HttpService flush]
-    * 09-19 11:12:21.423 ╔═════════════════════════════════════════════
-    * 09-19 11:12:21.423 ║ HTTP Service
-    * 09-19 11:12:21.423 ╠═════════════════════════════════════════════
-    * 09-19 11:12:21.446 [c.t.locationmanager.data.a.c first]
-    * 09-19 11:12:21.446   ✅  Locked 1 records
-    * 09-19 11:12:21.454 [c.t.l.http.HttpService a]
-    * 09-19 11:12:21.454   🔵  HTTP POST: bca5acc8-e358-4d8f-827f-b8c0d556b7bb
-    * 09-19 11:12:22.083 [c.t.l.http.HttpService$a onResponse]
-    * 09-19 11:12:22.083   🔵  Response: 200
-    * 09-19 11:12:22.100 [c.t.locationmanager.data.a.c destroy]
-    * 09-19 11:12:22.100   ✅  DESTROY: bca5acc8-e358-4d8f-827f-b8c0d556b7bb
-    * 09-19 11:12:55.226 [c.t.l.BackgroundGeolocationService onActivityRecognitionResult] still (100%)
-    *```
-    */
     getLog(query?: SQLQuery): Promise<string>;
-    /**
-      * Email the result of {@link Logger.getLog} using device's mail client.
-      *
-      * @example
-      * ```typescript
-      * let Logger = BackgroundGeolocation.logger;
-      * Logger.emailLog("foo@bar.com").then((success) => {
-      *   console.log("[emailLog] success");
-      * }).catch((error) => {
-      *   console.log("[emailLog] FAILURE: ", error);
-      * });
-      *
-      * // Or constrain results by providing a SQLQuery
-      * Logger.emailLog("foo@bar.com", {
-      *   start: Date.parse("2019-09-19"),
-      *   end: Date.parse("2019-09-20"),
-      *   order: Logger.ORDER_ASC,
-      *   limit: 1000
-      * });
-      * ```
-      *
-      * __ℹ️ See also:__
-      * - {@link LoggerConfig.logLevel}
-      * - {@link Logger.getLog}
-      * - {@link Logger.uploadLog}
-      * - 📘[Debugging Guide](github:wiki/Debugging).
-      */
     emailLog(email: string, query?: SQLQuery): Promise<void | boolean>;
-    /**
-    * Upload the result of {@link getLog} to provided url.  Provide an optional {@link SQLQuery} to contrain results between dates.  The file-upload
-    * request will attach your configured {@link HttpConfig.headers} for authentication.
-    *
-    * @example
-    *
-    * ```typescript
-    * BackgroundGeolocation.logger.uploadLog("https://my.server.com/users/123/logs").then((success) => {
-    *   console.log("[uploadLog] success");
-    * }).catch((error) => {
-    *   console.log("[uploadLog] FAILURE:", error);
-    * });
-    *
-    * // Or constrain results by providing a [SQLQuery]:
-    * BackgroundGeolocation.logger.uploadLog("https://my.server.com/users/123/logs", {
-    *   start: Date.parse("2019-10-20 09:00"),
-    *   end: Date.parse("2019-10-20 11:59")
-    * }).then((success) => {
-    *   console.log("[uploadLog] success");
-    * }).catch((error) => {
-    *   console.log("[uploadLog] FAILURE:", error);
-    * });
-    * ```
-    *
-    * __MultiPart File Upload__
-    * The SDK will upload the gzipped log-file to your server as a *Multi-part* file upload, the same log-file as used in {@link emailLog}.  This is what I see with my [Node server](https://github.com/transistorsoft/background-geolocation-console) at `request.files`:
-    *
-    * ```typescript
-    * app.post("/log", async function(req, res) {
-    *   console.log("[body]: ", req.body);
-    *   console.log("[files]: ", req.files);
-    *   res.status(200).send();
-    * });
-    * ```
-    * ![](https://dl.dropbox.com/s/cn86cu0vieor0j4/uploadLog-npm-server-request.png?dl=1)
-    *
-    * __Form Part__
-    *
-    * In addition to the log-file, the SDK will upload a form as well, containing the following parameters:
-    *
-    * | Key                 | Value                                                            |
-    * |--------------|------------------------------------------|
-    * | **`state`**    | *JSON-encoded result of SDK's `#getState`*|
-    * | **`model`** | *Device model* |
-    * | **`manufacturer`** | *Device manufacturer* |
-    * | **`platform`** | *iOS or Android* |
-    * | **`version`** | *OS version* |
-    *
-    * ### ℹ️ See also:
-    * - {@link LoggerConfig.logLevel}
-    * - {@link getLog}
-    * - {@link emailLog}
-    * - {@link destroyLog}
-    * - 📘[Debugging Guide](github:wiki/Debugging).
-    */
     uploadLog(url: string, query?: SQLQuery): Promise<void | boolean>;
-    /**
-    * Destroy the entire contents of SDK's log database.
-    *
-    * @example
-    * ```typescript
-    * BackgroundGeolocation.logger.destroyLog();
-    * ```
-    *
-    * __ℹ️ See also:__
-    * - {@link LoggerConfig.logLevel}
-    * - {@link getLog}
-    * - {@link emailLog}
-    * - {@link uploadLog}
-    * - 📘[Debugging Guide](github:wiki/Debugging)
-    */
     destroyLog(): Promise<void>;
 }

package/dist/core/api/State.d.ts

@@ -1,75 +1,12 @@
 import type { Config } from '../config/Config';
 import type { TrackingMode } from '../../enums/TrackingMode';
-/**
- * Effective runtime state returned by `BackgroundGeolocation.ready/getState`.
- *
- * `State` **is** the active {@link Config} (compound), plus runtime-only fields.
- *
- * @category Primary API
- */
 export interface State extends Config {
-    /** Whether the SDK has been enabled via `start` or `startGeofences`. */
     enabled: boolean;
-    /**
-     * Whether the SDK is currently in the *moving* state (vs stationary).
-     *
-     * @example
-     * ```typescript
-     * // If the SDK is currently in the *stationary* state, with State.isMoving == false:
-     *
-     * BackgroundGeolocation.onMotionChange((isMoving) => {
-     *   console.log('[onMotionChange] isMoving?', isMoving);
-     * });
-     *
-     * await BackgroundGeolocation.changePace(true);
-     * // State.isMoving is now true.
-     * ```
-     */
     isMoving: boolean;
-    /**
-     * `true` when a schedule is configured and `startSchedule()` executed.
-     * `stopSchedule()` will set this to `false`.
-     */
     schedulerEnabled: boolean;
-    /**
-     * Tracking mode.
-     *
-     * | Value | Name       | Description                   |
-     * |------:|------------|-------------------------------|
-     * | 0     | Geofences  | Monitor geofences only.       |
-     * | 1     | Location   | Monitor location + geofences. |
-     *
-     * @example
-     * ```typescript
-     * await BackgroundGeolocation.start();
-     *
-     * const state = await BackgroundGeolocation.getState();
-     * console.log('Tracking mode:', state.trackingMode);
-     * > 'Tracking mode: 1'
-     *
-     * await BackgroundGeolocation.startGeofences();
-     * console.log('Tracking mode:', state.trackingMode);
-     * > 'Tracking mode: 0'
-     * ```
-     */
     trackingMode: TrackingMode;
-    /**
-     * Current distance-traveled in meters.
-     * See: {@link odometerError}, {@link BackgroundGeolocation.setOdometer}, {@link BackgroundGeolocation.getOdometer}.
-     */
     odometer: number;
-    /**
-     * The accumulated error in the odometer (in meters).
-     */
     odometerError: number;
-    /**
-     * iOS only. `true` when the app was launched in the background due to a
-     * background event (fetch, geofence exit, stationary geofence exit).
-     * Always `false` on Android.
-     */
     didLaunchInBackground: boolean;
-    /**
-     * Indicates if the app was launched after a device reboot.
-     */
     didDeviceReboot: boolean;
 }