react-native-installer
v0.0.4
Published
A robust React Native module for programmatic APK installation on Android. Supports file installation, permissions handling, and error management.
Maintainers
Readme
React Native Installer
A robust React Native module for programmatic APK installation on Android. Supports file installation, permissions handling, and error management.
Features
- Programmatic Installation: Install APK files from the device storage.
- Cache Management: Clear app cache before installation.
- Promise-based API: Modern async/await interface.
- TypeScript Support: Full type definitions included.
- Error Handling: Detailed error messages.
Installation
npm install react-native-installer
# or
yarn add react-native-installerUsage
Install an APK
import { installAPK } from 'react-native-installer';
async function installUpdate(apkPath) {
try {
const result = await installAPK(apkPath, {
onSuccess: () => console.log('Installation started successfully'),
onError: (error) => console.error('Installation failed:', error),
clearCache: true // Optional: clear cache before install
});
console.log(result.message);
} catch (error) {
console.error('Error triggering installation:', error);
}
}Clear App Cache
import { clearAppCache } from 'react-native-installer';
async function cleanUp() {
try {
await clearAppCache();
console.log('Cache cleared!');
} catch (error) {
console.error('Failed to clear cache:', error);
}
}API Reference
installAPK(filePath, options?)
Installs an APK from the specified path.
| Parameter | Type | Description |
| :--- | :--- | :--- |
| filePath | string | Absolute path to the APK file. |
| options | object | Optional configuration object. |
Options:
| Option | Type | Default | Description |
| :--- | :--- | :--- | :--- |
| clearCache | boolean | false | Clear the app's cache before installation. |
| packageName | string | current app | Package name to clear cache for (if clearCache is true). |
| timeout | number | 10000 | Timeout in milliseconds. |
| onSuccess | function | - | Callback when installation Intent is launched. |
| onError | function | - | Callback on error. |
clearAppCache(packageName?, onError?)
Clears the application cache.
| Parameter | Type | Description |
| :--- | :--- | :--- |
| packageName | string | Optional package name. Defaults to current app. |
| onError | function | Optional error callback. |
isSupported()
Returns true if the current platform supports APK installation (Android), false otherwise.
Permissions
Ensure you have the necessary permissions in your AndroidManifest.xml:
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
<uses-permission android:name="android.permission.REQUEST_INSTALL_PACKAGES" />License
JESCON TECHNOLOGIES PVT LTD
