0.0.2 • Published 8 months ago

@danyalwe/capacitor-battery v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
8 months ago

Capacitor Plugin - Battery

Get access to every info about the device battery!

Supported Android version: 21+\ Supported iOS version: Not supported\ Supported Browsers: Chromium-based

Install

npm install @danyalwe/capacitor-battery
npx cap sync

Todos

  • Improve documentation, add JSDoc strings
  • Add support for iOS

Supported methods

NameAndroidiOSWeb
start
stop
addListener
removeAllListeners

Supported properties

PropertyAndroidiOSWeb
currentCapacity
totalCapacity
realPercentage
technology
temperature
voltage
amperage
wattage
health
status
chargeMode
level
hasBattery
isCharging
chargingTime
dischargingTime

API

start()

start() => Promise<Battery | undefined>

Returns: Promise<Battery>


stop()

stop() => Promise<void>

addListener('batteryChange', ...)

addListener(eventName: 'batteryChange', listenerFunc: (event: Battery) => void) => Promise<PluginListenerHandle>
ParamType
eventName'batteryChange'
listenerFunc(event: Battery) => void

Returns: Promise<PluginListenerHandle>


removeAllListeners()

removeAllListeners() => Promise<void>

Interfaces

Battery

PropType
levelnumber
hasBatteryboolean
isChargingboolean
chargingTimenumber
dischargingTimenumber
currentCapacitynumber
totalCapacitynumber
realPercentagenumber
technologystring
temperaturenumber
voltagenumber
amperagenumber
wattagenumber
healthBatteryHealth
statusBatteryStatus
chargeModeBatteryChargeMode

PluginListenerHandle

PropType
remove() => Promise<void>

Enums

BatteryHealth

Members
UNKNOWN
COLD
DEAD
GOOD
OVERHEAT
OVER_VOLTAGE
FAILURE

BatteryStatus

Members
UNKNOWN
NOT_CHARGING
DISCHARGING
CHARGING
FULL

BatteryChargeMode

Members
UNKNOWN
AC
USB
DOCK
WIRELESS