API Reference

This plugin provides 5 getters to read device information, plus a reactive watch API to subscribe to changes.

Functions Overview

Function	Description
getDeviceInfo()	Device identification and hardware info
getBatteryInfo()	Battery status and health
getNetworkInfo()	Network connection details
getStorageInfo()	Storage capacity information
getDisplayInfo()	Display properties and capabilities
watch*()	Subscribe to changes for any of the above kinds

Quick Reference

import { 
  getDeviceInfo,    // → DeviceInfoResponse
  getBatteryInfo,   // → BatteryInfo
  getNetworkInfo,   // → NetworkInfo
  getStorageInfo,   // → StorageInfo
  getDisplayInfo,   // → DisplayInfo

  // Reactive watch API → Promise<UnwatchFn>
  watchDevice,
  watchBattery,
  watchNetwork,
  watchStorage,
  watchDisplay
} from 'tauri-plugin-device-info-api';

Type Exports

All response types are exported for TypeScript users:

import type { 
  DeviceInfoResponse, 
  BatteryInfo, 
  NetworkInfo, 
  StorageInfo, 
  DisplayInfo,
  WatchOptions,
  UnwatchFn
} from 'tauri-plugin-device-info-api';

Naming Convention

The JavaScript API uses camelCase for all property names:

Rust (internal)	JavaScript
is_charging	isCharging
ip_address	ipAddress
mac_address	macAddress
total_space	totalSpace
free_space	freeSpace
storage_type	storageType
scale_factor	scaleFactor
refresh_rate	refreshRate