# cordova-plugin-osx-battery

> Cordova battery plugin for OSX platform

Latest version **1.0.0** (published 2019-04-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install cordova-plugin-osx-battery
pnpm add cordova-plugin-osx-battery
yarn add cordova-plugin-osx-battery
bun add cordova-plugin-osx-battery
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2019-04-16 |
| First published | 2019-04-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 10.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | jardenliu |
| Maintainers | jardenliu |
| Keywords | ecosystem:cordova, cordova-osx |

## Links

- npm: https://www.npmjs.com/package/cordova-plugin-osx-battery
- Repository: https://github.com/jardenliu/cordova-plugin-osx-battery
- Homepage: https://github.com/jardenliu/cordova-plugin-osx-battery#readme
- Issues: https://github.com/jardenliu/cordova-plugin-osx-battery/issues
- npm.io page: https://npm.io/package/cordova-plugin-osx-battery

## Recent versions

- 1.0.0 (latest) — 2019-04-16

## README

# cordova-plugin-osx-battery

> The README.md && OSXBettery.js is forked from [apache/cordova-plugin-battery-status](https://github.com/apache/cordova-plugin-battery-status).

This plugin provides an implementation of an old version of the [Battery Status Events API][w3c_spec]. It adds the following three events to the `window` object:

* batterystatus
* batterycritical
* batterylow

Applications may use `window.addEventListener` to attach an event listener for any of the above events after the `deviceready` event fires.

## Installation

    cordova plugin add cordova-plugin-osx-battery

## Status object

All events in this plugin return an object with the following properties:

- __level__: The battery charge percentage (0-100). _(Number)_
- __isPlugged__: A boolean that indicates whether the device is plugged in. _(Boolean)_

## batterystatus event

Fires when the battery charge percentage changes by at least 1 percent, or when the device is plugged in or unplugged. Returns an [object][status_object] containing battery status.

### Example

    window.addEventListener("batterystatus", onBatteryStatus, false);

    function onBatteryStatus(status) {
        console.log("Level: " + status.level + " isPlugged: " + status.isPlugged);
    }

### Supported Platforms

- OSX

## batterylow event

Fires when the battery charge percentage reaches the low charge threshold. This threshold value is device-specific. Returns an [object][status_object] containing battery status.

### Example

    window.addEventListener("batterylow", onBatteryLow, false);

    function onBatteryLow(status) {
        alert("Battery Level Low " + status.level + "%");
    }

### Supported Platforms

- OSX

## batterycritical event

Fires when the battery charge percentage reaches the critical charge threshold. This threshold value is device-specific. Returns an [object][status_object] containing battery status.

### Example

    window.addEventListener("batterycritical", onBatteryCritical, false);

    function onBatteryCritical(status) {
        alert("Battery Level Critical " + status.level + "%\nRecharge Soon!");
    }

### Supported Platforms

- OSX


[w3c_spec]: https://www.w3.org/TR/battery-status/
[status_object]: #status-object

---
_Source: https://npm.io/package/cordova-plugin-osx-battery · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._