@capgo/capacitor-device-info 8.0.0

package/dist/docs.json

@@ -0,0 +1,1285 @@
+{
+  "api": {
+    "name": "DeviceInfoPlugin",
+    "slug": "deviceinfoplugin",
+    "docs": "Capacitor plugin contract for reading device CPU, memory, GPU, storage, and onboard sensor metrics.",
+    "tags": [
+      {
+        "text": "8.0.0",
+        "name": "since"
+      }
+    ],
+    "methods": [
+      {
+        "name": "getInfo",
+        "signature": "() => Promise<DeviceInfoSnapshot>",
+        "parameters": [],
+        "returns": "Promise<DeviceInfoSnapshot>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Read one CPU, memory, GPU, storage, thermal, and onboard sensor snapshot.",
+        "complexTypes": [
+          "DeviceInfoSnapshot"
+        ],
+        "slug": "getinfo"
+      },
+      {
+        "name": "startMonitoring",
+        "signature": "(options?: MonitoringOptions | undefined) => Promise<StartMonitoringResult>",
+        "parameters": [
+          {
+            "name": "options",
+            "docs": "",
+            "type": "MonitoringOptions | undefined"
+          }
+        ],
+        "returns": "Promise<StartMonitoringResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Start periodic device snapshots.\n\nListen to `deviceInfoUpdate` to receive samples. Calling this while monitoring\nis already active restarts monitoring with the new options.",
+        "complexTypes": [
+          "StartMonitoringResult",
+          "MonitoringOptions"
+        ],
+        "slug": "startmonitoring"
+      },
+      {
+        "name": "stopMonitoring",
+        "signature": "() => Promise<StopMonitoringResult>",
+        "parameters": [],
+        "returns": "Promise<StopMonitoringResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Stop periodic device snapshots.",
+        "complexTypes": [
+          "StopMonitoringResult"
+        ],
+        "slug": "stopmonitoring"
+      },
+      {
+        "name": "isMonitoring",
+        "signature": "() => Promise<MonitoringState>",
+        "parameters": [],
+        "returns": "Promise<MonitoringState>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Return current periodic monitoring state.",
+        "complexTypes": [
+          "MonitoringState"
+        ],
+        "slug": "ismonitoring"
+      },
+      {
+        "name": "addListener",
+        "signature": "(eventName: 'deviceInfoUpdate', listenerFunc: (event: DeviceInfoUpdate) => void) => Promise<PluginListenerHandle>",
+        "parameters": [
+          {
+            "name": "eventName",
+            "docs": "Only the `deviceInfoUpdate` event is supported.",
+            "type": "'deviceInfoUpdate'"
+          },
+          {
+            "name": "listenerFunc",
+            "docs": "Callback invoked with each snapshot.",
+            "type": "(event: DeviceInfoUpdate) => void"
+          }
+        ],
+        "returns": "Promise<PluginListenerHandle>",
+        "tags": [
+          {
+            "name": "param",
+            "text": "eventName Only the `deviceInfoUpdate` event is supported."
+          },
+          {
+            "name": "param",
+            "text": "listenerFunc Callback invoked with each snapshot."
+          },
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Listen for periodic device snapshots.",
+        "complexTypes": [
+          "PluginListenerHandle",
+          "DeviceInfoUpdate"
+        ],
+        "slug": "addlistenerdeviceinfoupdate-"
+      },
+      {
+        "name": "removeAllListeners",
+        "signature": "() => Promise<void>",
+        "parameters": [],
+        "returns": "Promise<void>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Remove all listeners that have been registered on the plugin.",
+        "complexTypes": [],
+        "slug": "removealllisteners"
+      },
+      {
+        "name": "getPluginVersion",
+        "signature": "() => Promise<PluginVersionResult>",
+        "parameters": [],
+        "returns": "Promise<PluginVersionResult>",
+        "tags": [
+          {
+            "name": "since",
+            "text": "8.0.0"
+          }
+        ],
+        "docs": "Get the native Capacitor plugin version.",
+        "complexTypes": [
+          "PluginVersionResult"
+        ],
+        "slug": "getpluginversion"
+      }
+    ],
+    "properties": []
+  },
+  "interfaces": [
+    {
+      "name": "DeviceInfoSnapshot",
+      "slug": "deviceinfosnapshot",
+      "docs": "Instant device snapshot returned by {@link DeviceInfoPlugin.getInfo}.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "timestamp",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Snapshot timestamp as Unix epoch milliseconds.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "platform",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Platform implementation that produced the snapshot.",
+          "complexTypes": [],
+          "type": "'ios' | 'android' | 'web'"
+        },
+        {
+          "name": "cpu",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "CPU information and usage.",
+          "complexTypes": [
+            "CpuInfo"
+          ],
+          "type": "CpuInfo"
+        },
+        {
+          "name": "memory",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Memory information and usage.",
+          "complexTypes": [
+            "MemoryInfo"
+          ],
+          "type": "MemoryInfo"
+        },
+        {
+          "name": "storage",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Storage information and usage.",
+          "complexTypes": [
+            "StorageInfo"
+          ],
+          "type": "StorageInfo"
+        },
+        {
+          "name": "gpu",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "GPU information when the platform exposes it.",
+          "complexTypes": [
+            "GpuInfo"
+          ],
+          "type": "GpuInfo"
+        },
+        {
+          "name": "thermalState",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Thermal state when the platform exposes it.",
+          "complexTypes": [
+            "ThermalState"
+          ],
+          "type": "ThermalState"
+        },
+        {
+          "name": "lowPowerMode",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Low-power mode state when the platform exposes it.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "sensors",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Onboard sensor availability and readings.",
+          "complexTypes": [
+            "OnboardSensorsInfo"
+          ],
+          "type": "OnboardSensorsInfo"
+        }
+      ]
+    },
+    {
+      "name": "CpuInfo",
+      "slug": "cpuinfo",
+      "docs": "CPU snapshot for the current device.\n\nAll frequency values are reported in hertz. `usagePercent` is `null` when a\nplatform needs at least two samples to calculate CPU usage.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "cores",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Total logical CPU cores visible to the app.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "activeCores",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Logical CPU cores currently active, when the platform exposes it.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "architecture",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "CPU architecture, for example `arm64` or `x86_64`.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "model",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "CPU or SoC model identifier when available.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "usagePercent",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "System CPU usage from 0 to 100.",
+          "complexTypes": [],
+          "type": "number | null | undefined"
+        },
+        {
+          "name": "maxFrequencyHz",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Highest CPU frequency exposed by the platform.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "temperatureCelsius",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "CPU temperature in Celsius when the platform exposes an onboard thermal sensor.\n\nAndroid reads this as a best-effort value from device thermal zones. iOS does\nnot expose raw CPU temperature through public APIs.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "MemoryInfo",
+      "slug": "memoryinfo",
+      "docs": "Memory snapshot for the current device and app process.\n\nAll size values are reported in bytes.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "totalBytes",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Total physical memory on the device.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "freeBytes",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Memory available to the system.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "usedBytes",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Memory currently used by the system.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "usedPercent",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Memory usage from 0 to 100.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "appUsedBytes",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Memory used by the current app process.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "appLimitBytes",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Heap limit visible to the current app process.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "lowMemory",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether the OS currently reports low-memory pressure.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        },
+        {
+          "name": "pressure",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Platform memory pressure label.",
+          "complexTypes": [],
+          "type": "'normal' | 'warning' | 'critical' | 'unknown' | undefined"
+        }
+      ]
+    },
+    {
+      "name": "StorageInfo",
+      "slug": "storageinfo",
+      "docs": "Storage snapshot for the app data volume.\n\nAll size values are reported in bytes.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "totalBytes",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Total bytes on the app data volume.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "freeBytes",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Free bytes on the app data volume.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "usedBytes",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Used bytes on the app data volume.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "usedPercent",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Storage usage from 0 to 100.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "GpuInfo",
+      "slug": "gpuinfo",
+      "docs": "GPU snapshot for the primary graphics device.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "api",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Graphics API used to query the GPU.",
+          "complexTypes": [],
+          "type": "'unknown' | 'metal' | 'opengl' | 'webgl' | undefined"
+        },
+        {
+          "name": "vendor",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "GPU vendor when available.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "renderer",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "GPU renderer or model name when available.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "version",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Graphics API version string when available.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "maxTextureSize",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Maximum texture size reported by the graphics API.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "temperatureCelsius",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "GPU temperature in Celsius when the platform exposes an onboard thermal sensor.\n\nAndroid reads this as a best-effort value from device thermal zones. iOS does\nnot expose raw GPU temperature through public APIs.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "OnboardSensorsInfo",
+      "slug": "onboardsensorsinfo",
+      "docs": "Onboard sensors snapshot.\n\nThis only reports hardware sensors exposed by the device or operating system.\nIt does not fetch weather data or any external temperature/humidity source.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "availableSensors",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sensors available to the app.",
+          "complexTypes": [
+            "OnboardSensorDescriptor"
+          ],
+          "type": "OnboardSensorDescriptor[] | undefined"
+        },
+        {
+          "name": "readings",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Instant sensor readings captured for common environmental sensors.",
+          "complexTypes": [
+            "OnboardSensorReading"
+          ],
+          "type": "OnboardSensorReading[] | undefined"
+        },
+        {
+          "name": "batteryTemperatureCelsius",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Battery temperature in Celsius when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "ambientTemperatureCelsius",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Ambient air temperature from an onboard sensor in Celsius when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "relativeHumidityPercent",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Relative humidity from an onboard sensor as a percentage when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "pressureHpa",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Atmospheric pressure from an onboard barometer in hectopascals when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "illuminanceLux",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Ambient light from an onboard light sensor in lux when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "proximityDistanceCm",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Proximity distance from an onboard proximity sensor in centimeters when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "OnboardSensorDescriptor",
+      "slug": "onboardsensordescriptor",
+      "docs": "Description of an onboard hardware sensor exposed by the platform.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "type",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Stable sensor type label, for example `pressure`, `ambientTemperature`, or `accelerometer`.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Platform sensor name when available.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "vendor",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sensor vendor when available.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "platformType",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Android sensor type id when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "maximumRange",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Maximum sensor range when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "resolution",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sensor resolution when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "powerMilliamp",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sensor power draw in milliamps when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "minDelayMicroseconds",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Minimum sensor delay in microseconds when available.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "wakeUp",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether this is a wake-up sensor when available.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "OnboardSensorReading",
+      "slug": "onboardsensorreading",
+      "docs": "Instant onboard sensor reading.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "type",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Stable sensor type label.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "unit",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Human-readable unit, for example `celsius`, `percent`, `hPa`, `lux`, or `cm`.",
+          "complexTypes": [],
+          "type": "string"
+        },
+        {
+          "name": "value",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Sensor value.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "name",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Platform sensor name when available.",
+          "complexTypes": [],
+          "type": "string | undefined"
+        },
+        {
+          "name": "timestamp",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Reading timestamp as Unix epoch milliseconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "StartMonitoringResult",
+      "slug": "startmonitoringresult",
+      "docs": "Result returned when monitoring starts.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "monitoring",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether monitoring is active.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "intervalMs",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Effective interval in milliseconds.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "startedAt",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Monitoring start timestamp as Unix epoch milliseconds.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "MonitoringOptions",
+      "slug": "monitoringoptions",
+      "docs": "Options used to start periodic device snapshots.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "intervalMs",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Time between samples in milliseconds.\n\nValues below 250ms are clamped to 250ms to avoid excessive native work.\nDefaults to 1000ms.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "durationMs",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Stop automatically after this duration in milliseconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "sampleCount",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Stop automatically after this number of emitted samples.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "emitImmediately",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Emit one sample immediately when monitoring starts.\n\nDefaults to `true`.",
+          "complexTypes": [],
+          "type": "boolean | undefined"
+        }
+      ]
+    },
+    {
+      "name": "StopMonitoringResult",
+      "slug": "stopmonitoringresult",
+      "docs": "Result returned by {@link DeviceInfoPlugin.stopMonitoring}.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "monitoring",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether monitoring remains active after the stop request.",
+          "complexTypes": [],
+          "type": "boolean"
+        }
+      ]
+    },
+    {
+      "name": "MonitoringState",
+      "slug": "monitoringstate",
+      "docs": "Current monitoring state.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "monitoring",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Whether monitoring is active.",
+          "complexTypes": [],
+          "type": "boolean"
+        },
+        {
+          "name": "intervalMs",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Effective interval in milliseconds when monitoring is active.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "startedAt",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Monitoring start timestamp as Unix epoch milliseconds.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        },
+        {
+          "name": "samplesEmitted",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Number of samples emitted by the active monitoring session.",
+          "complexTypes": [],
+          "type": "number | undefined"
+        }
+      ]
+    },
+    {
+      "name": "PluginListenerHandle",
+      "slug": "pluginlistenerhandle",
+      "docs": "",
+      "tags": [],
+      "methods": [],
+      "properties": [
+        {
+          "name": "remove",
+          "tags": [],
+          "docs": "",
+          "complexTypes": [],
+          "type": "() => Promise<void>"
+        }
+      ]
+    },
+    {
+      "name": "DeviceInfoUpdate",
+      "slug": "deviceinfoupdate",
+      "docs": "Periodic event payload emitted while monitoring is active.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "sequence",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "One-based sample sequence for the active monitoring session.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "startedAt",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Monitoring start timestamp as Unix epoch milliseconds.",
+          "complexTypes": [],
+          "type": "number"
+        },
+        {
+          "name": "elapsedMs",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Elapsed milliseconds since monitoring started.",
+          "complexTypes": [],
+          "type": "number"
+        }
+      ]
+    },
+    {
+      "name": "PluginVersionResult",
+      "slug": "pluginversionresult",
+      "docs": "Plugin version payload.",
+      "tags": [
+        {
+          "text": "8.0.0",
+          "name": "since"
+        }
+      ],
+      "methods": [],
+      "properties": [
+        {
+          "name": "version",
+          "tags": [
+            {
+              "text": "8.0.0",
+              "name": "since"
+            }
+          ],
+          "docs": "Version identifier returned by the platform implementation.",
+          "complexTypes": [],
+          "type": "string"
+        }
+      ]
+    }
+  ],
+  "enums": [],
+  "typeAliases": [
+    {
+      "name": "ThermalState",
+      "slug": "thermalstate",
+      "docs": "Thermal state reported by the platform.",
+      "types": [
+        {
+          "text": "'nominal'",
+          "complexTypes": []
+        },
+        {
+          "text": "'fair'",
+          "complexTypes": []
+        },
+        {
+          "text": "'serious'",
+          "complexTypes": []
+        },
+        {
+          "text": "'critical'",
+          "complexTypes": []
+        },
+        {
+          "text": "'unknown'",
+          "complexTypes": []
+        }
+      ]
+    }
+  ],
+  "pluginConfigs": []
+}