{"_id":"@awesome-cordova-library/batterystatus","_rev":"1-95e8562fae144ea5d1bef1b87eba586c","name":"@awesome-cordova-library/batterystatus","dist-tags":{"latest":"1.0.1"},"versions":{"1.0.0":{"name":"@awesome-cordova-library/batterystatus","version":"1.0.0","description":"This plugin provides an implementation of an old version of the Battery Status Events API.","main":"lib/index.js","types":"lib/index.d.ts","keywords":["cordova","capacitor","ionic","javascript","mobile","battery status","cordova-battery","battery"],"publishConfig":{"access":"public"},"author":{"name":"Jordan AZOULAY","email":"jazoulay@joazco.com","url":"https://github.com/joazco"},"license":"SEE LICENSE IN LICENSE","repository":{"type":"git","url":"git://github.com/joazco/awesome-cordova-library.git"},"bugs":{"url":"https://github.com/joazco/awesome-cordova-library/issues"},"homepage":"https://github.com/joazco/awesome-cordova-library","devDependencies":{"@types/jest":"^27.5.1","@types/react":"~17.0.21","jest":"^28.1.0","prettier":"^2.6.2","ts-jest":"^28.0.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.7.2"},"scripts":{"build":"rm -rf lib/ && tsc","build-yalc":"npm run build; yalc publish --push --private","test":"jest --config jestconfig.json","format":"prettier --write \"src/**/*.ts\"","lint":"tslint -p tsconfig.json","prepublish":"npm run format; npm run lint; npm test; npm run build"},"directories":{"lib":"lib"},"dependencies":{},"gitHead":"f981d033a7e3a183c0dbf4e83a064920842e4154","_id":"@awesome-cordova-library/batterystatus@1.0.0","_nodeVersion":"16.18.0","_npmVersion":"8.5.2","dist":{"integrity":"sha512-LKG28a6eH48P76bCTD6iOzFWg+TvVFcxkTNzUQ8gAI9Sa5KK44gdGrLa2JuQd459fkdlVkVBBsYnFDmo4Iig8Q==","shasum":"810fea72ebd266abf549f8c840ffd04b337faeb3","tarball":"https://registry.npmjs.org/@awesome-cordova-library/batterystatus/-/batterystatus-1.0.0.tgz","fileCount":9,"unpackedSize":12585,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIDdHQj9G81h0C3kYD85nwRmAA6EURDy9NIMcemds0u5PAiB08ZtTdt6JlRs/ZVLfcmZlpzx+kN2xGGkcZX8Mg/Nhdw=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjT/DSACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqCqhAAlDYdlAkNGJTaFDX58ZOSERYuDW4akZq5DjrUTAEX9DLReNzF\r\nlukeYhzO0ZOfV6DXzh4vZMl9VmHYLsW+8UCHdYJNMjCnyPW0DeBp9UjIo86B\r\nP+o5CQl/z1bXNf9gLITHT0myeJBN2qCwyfxrGo8Z5BJzxNvOgOVDKQznXFeG\r\ndpT7HEUPVerTNxvyhpKir6ZCSkOAY7hCPwvLGxiwOuJy06UtC5qE5bqNbCRh\r\nqnsGOV7iD0P1e3GBaEmQcnMK/XqvPIW2mOgVgcumeWoLbqTDwtvT9mbyG++F\r\nGUpYcR+za8yfZPUkyooxLELckoQgYfHhNrHKLf+qgFC2CJPdwmzPbhvAVmt+\r\ncIKI6LXyjA/T/pVjLrF3KFfDftdY6U38SGQ2JWjw1hetGlrwAmBwGkmprczl\r\nbrDVqidIqaFgbukYIB+N5rs8X6f4vhLZMif7lrrhhbOSA1drU/0V+jfg4qCu\r\nXEScMBp/sNczsjYJLFIZdtoZAuuGMA+a2276LBWrupaVgFgINu1FVx76j/gA\r\nkvgGPSzZWwFFCscdKsJmjOCijGtLr3aBLlBED+VcwYG874bG5ir3ueK3jDB3\r\nZDDObaQGc8+xAhfXhhnhaKqG6nam5cjVYCwZi2svK5Wk4JPn0PotwTCoSLtt\r\ngFq7DENMuc5iX1NmqeXZOtFMjNxeRdFk4Jo=\r\n=itm6\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"joazco","email":"jazoulay@joazco.com"},"maintainers":[{"name":"joazco","email":"jazoulay@joazco.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/batterystatus_1.0.0_1666183378179_0.8887598531023964"},"_hasShrinkwrap":false},"1.0.1":{"name":"@awesome-cordova-library/batterystatus","version":"1.0.1","description":"This plugin provides an implementation of an old version of the Battery Status Events API.","main":"lib/index.js","types":"lib/index.d.ts","keywords":["cordova","capacitor","ionic","javascript","mobile","battery status","cordova-battery","battery"],"publishConfig":{"access":"public"},"author":{"name":"Jordan AZOULAY","email":"jazoulay@joazco.com","url":"https://github.com/joazco"},"license":"SEE LICENSE IN LICENSE","repository":{"type":"git","url":"git://github.com/joazco/awesome-cordova-library.git"},"bugs":{"url":"https://github.com/joazco/awesome-cordova-library/issues"},"homepage":"https://github.com/joazco/awesome-cordova-library","devDependencies":{"@types/jest":"^27.5.1","@types/react":"~17.0.21","jest":"^28.1.0","prettier":"^2.6.2","ts-jest":"^28.0.3","tslint":"^6.1.3","tslint-config-prettier":"^1.18.0","typescript":"^4.7.2"},"scripts":{"build":"rm -rf lib/ && tsc","build-yalc":"npm run build; yalc publish --push --private","test":"jest --config jestconfig.json","format":"prettier --write \"./src/**/*.ts\"","lint":"tslint -p tsconfig.json","prepublish":"npm run format; npm run lint; npm test; npm run build"},"directories":{"lib":"lib"},"dependencies":{},"gitHead":"2a2b9cf007a870056251632315547e6a651d26a0","_id":"@awesome-cordova-library/batterystatus@1.0.1","_nodeVersion":"16.20.0","_npmVersion":"8.19.4","dist":{"integrity":"sha512-4dTYjksXFypNIT1MT2CnoZRWz6Clkn5DH0fbQ1hfZBFbRqvpoZIjYBxbuQMiUgBahopx5DzMmQUBlB5Hods4Aw==","shasum":"f733e5d9720d7346eb799e390f3f7aeafc268284","tarball":"https://registry.npmjs.org/@awesome-cordova-library/batterystatus/-/batterystatus-1.0.1.tgz","fileCount":9,"unpackedSize":13011,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDVRa1xDZ0q9aTGef4ojYmYY52ptuU0tgvOq+bmAQDanAiEAx8hr/SEB1IXiEZbX0UQ1aG3aO1UaUI2rE74OBuks5xM="}]},"_npmUser":{"name":"joazco","email":"jazoulay@joazco.com"},"maintainers":[{"name":"joazco","email":"jazoulay@joazco.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/batterystatus_1.0.1_1694498339471_0.3141306689376657"},"_hasShrinkwrap":false}},"time":{"created":"2022-10-19T12:42:58.111Z","1.0.0":"2022-10-19T12:42:58.352Z","modified":"2023-09-12T05:58:59.911Z","1.0.1":"2023-09-12T05:58:59.642Z"},"maintainers":[{"name":"joazco","email":"jazoulay@joazco.com"}],"description":"This plugin provides an implementation of an old version of the Battery Status Events API.","homepage":"https://github.com/joazco/awesome-cordova-library","keywords":["cordova","capacitor","ionic","javascript","mobile","battery status","cordova-battery","battery"],"repository":{"type":"git","url":"git://github.com/joazco/awesome-cordova-library.git"},"author":{"name":"Jordan AZOULAY","email":"jazoulay@joazco.com","url":"https://github.com/joazco"},"bugs":{"url":"https://github.com/joazco/awesome-cordova-library/issues"},"license":"SEE LICENSE IN LICENSE","readme":"---\nid: plugin-battery-status\ntitle: Battery Status\ntags:\n - cordova\n - capacitor\n - ionic\n - javascript\n - typescript\n - plugin\n - mobile\n - battery status\n---\n\n# Battery Status\n\nThis plugin provides an implementation of an old version of the Battery Status Events API.\n\n[Online documentation](https://awesomecordovalibrary.com)\n\n[Cordova documentation](https://cordova.apache.org/docs/en/11.x/reference/cordova-plugin-battery-status/index.html)\n\n## Installation\n\n### Cordova\n\n```bash\ncordova plugin add cordova-plugin-battery-status\nnpm install @awesome-cordova-library/batterystatus\n```\n\n### Capacitor / Ionic\n\n```bash\nnpm install cordova-plugin-battery-status\nnpm install @awesome-cordova-library/batterystatus\nnpx cap sync\n```\n\n## Vanilla\n\n### Declaration\n\n```typescript\nclass BatteryStatus {\n /**\n * Fires when the battery charge percentage changes by at least 1 percent, or when the device is plugged in or unplugged. Returns an object containing battery status.\n * @param callback {(batterystatus: BatteryStatusType) => void}\n */\n static onBatteryStatus(\n callback: (batterystatus: BatteryStatusType) => void\n ): void;\n /**\n * Fires when the battery charge percentage changes by at least 1 percent, or when the device is plugged in or unplugged. Returns an object containing battery status.\n * @param callback {(batterystatus: BatteryStatusType) => void}\n */\n static onBatteryStatusWeb(\n callback: (batterystatus: BatteryStatusType) => void\n ): void;\n /**\n * Fires when the battery charge percentage reaches the low charge threshold. This threshold value is device-specific.\n * Incompatible without cordova\n * @param callback {(batterystatus: BatteryStatusType) => void}\n */\n static onBatteryLow(\n callback: (batterystatus: BatteryStatusType) => void\n ): void;\n /**\n * Fires when the battery charge percentage reaches the critical charge threshold. This threshold value is device-specific.\n * Incompatible without cordova\n * @param callback {(batterystatus: BatteryStatusType) => void}\n */\n static onBatteryCritical(\n callback: (batterystatus: BatteryStatusType) => void\n ): void;\n}\n```\n\n### Usages\n\n```typescript\nimport BatteryStatus from \"@awesome-cordova-library/batterystatus\";\n\nBatteryStatus.onBatteryStatus((batterystatus) => {\n console.log(\n `Battery is plugged: ${batterystatus.isPlugged} // Battery level: ${batterystatus.level}`\n );\n});\n```\n\n## React\n\n### Declaration\n\n```typescript\nconst useBatteryStatus: () => {\n onBatteryStatus: (\n callback: (batterystatus: BatteryStatusType) => void\n ) => void;\n onBatteryLow: (callback: (batterystatus: BatteryStatusType) => void) => void;\n onBatteryCritical: (\n callback: (batterystatus: BatteryStatusType) => void\n ) => void;\n};\n```\n\n### Usages\n\n```typescript\nimport { useEffect, useState } from \"react\";\nimport { BatteryStatusType } from \"@awesome-cordova-library/batterystatus\";\nimport useBatteryStatus from \"@awesome-cordova-library/batterystatus/lib/react\";\n\nfunction App() {\n const [batteryStatus, setBatteryStatus] = useState();\n const { onBatteryStatus } = useBatteryStatus();\n\n useEffect(() => {\n onBatteryStatus((batterystatus) => {\n setBatteryStatus(batterystatus);\n });\n }, [onBatteryStatus]);\n\n return (\n
\n

Battery Is plugged: {String(batteryStatus?.isPlugged)}

\n

Battery level: {batteryStatus?.level}

\n
\n );\n}\n```\n","readmeFilename":"README.md"}