Skip to main content

@rtorcato/browser-common / battery

battery

Functions​

isBatteryApiAvailable()​

isBatteryApiAvailable(): boolean

Defined in: battery/index.ts:9

Checks if the Battery Status API is available in the current environment.

Returns​

boolean

Example​

import { isBatteryApiAvailable } from '@rtorcato/browser-common/battery'
if (isBatteryApiAvailable()) showBatteryUI()

getBatteryManager()​

getBatteryManager(): Promise<BatteryManager | undefined>

Defined in: battery/index.ts:40

Gets the BatteryManager object if available.

Returns​

Promise<BatteryManager | undefined>

A promise resolving to the BatteryManager, or undefined if not supported.

Example​

import { getBatteryManager } from '@rtorcato/browser-common/battery'
const battery = await getBatteryManager()
console.log(battery?.level)

onBatteryLevelChange()​

onBatteryLevelChange(battery, callback): () => void

Defined in: battery/index.ts:63

Adds a listener for battery level changes.

Parameters​

battery​

BatteryManager

The BatteryManager object.

callback​

() => void

The callback to run on level change.

Returns​

A function to remove the event listener.

() => void

Example​

import { getBatteryManager, onBatteryLevelChange } from '@rtorcato/browser-common/battery'
const battery = await getBatteryManager()
const off = battery && onBatteryLevelChange(battery, () => console.log(battery.level))
off?.()

onBatteryChargingChange()​

onBatteryChargingChange(battery, callback): () => void

Defined in: battery/index.ts:81

Adds a listener for charging state changes.

Parameters​

battery​

BatteryManager

The BatteryManager object.

callback​

() => void

The callback to run on charging change.

Returns​

A function to remove the event listener.

() => void

Example​

import { getBatteryManager, onBatteryChargingChange } from '@rtorcato/browser-common/battery'
const battery = await getBatteryManager()
const off = battery && onBatteryChargingChange(battery, () => console.log(battery.charging))
off?.()