Skip to content

m3allimm4a4/capacitor-zip

Repository files navigation

capacitor-zip (npm)

Work in progress. Zip and Unzip files on android. Based on Zip4j library. Zip functionnality still not implemented only unzip works for now. Tested on capacitor v3, not tested on older capacitor versions.

Install

npm install capacitor-zip
npx cap sync

Android permissions

Make sure to add the following permissions in the application android manifest.xml

<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>

API

unzip(...)

unzip(options: UnzipOptions) => Promise<UnzipResult>
Param Type
options UnzipOptions

Returns: Promise<UnzipResult>


Interfaces

UnzipResult

Prop Type
message string
uri string

UnzipOptions

Prop Type
source string
destination string
password string