React Native Zip Archive
Zip archive utility for react-native
Installation
npm install react-native-zip-archive --savereact-native link react-native-zip-archive
Usage
import it into your code
you may also want to use something like react-native-fs to access the file system (check its repo for more information)
API
zip(source: string, target: string): Promise
zip source to target
Example
const targetPath = `/myFile.zip`const sourcePath = DocumentDirectoryPath
unzip(source: string, target: string): Promise
unzip from source to target
Example
const sourcePath = `/myFile.zip`const targetPath = DocumentDirectoryPath
unzipAssets(assetPath: string, target: string): Promise
unzip file from Android
assets
folder to target path
Note: Android only.
assetPath
is the relative path to the file inside the pre-bundled assets folder, e.g. folder/myFile.zip
. Do not pass an absolute directory.
const assetPath = `/myFile.zip`const targetPath = DocumentDirectoryPath
subscribe(callback: ({progress: number})): EmitterSubscription
Subscribe to unzip progress callbacks. Useful for displaying a progress bar on your UI during the unzip process.
Your callback will be passed an object with the following fields:
progress
(number) a value from 0 to 1 representing the progress of the unzip method. 1 is completed.
Note: Remember to unsubscribe! Run .remove() on the object returned by this method.
{ thiszipProgress = } { // Important: Unsubscribe from the progress events thiszipProgress}