Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fortunen/cordova-plugin-zeep

Zip compression/decompression for the cordova/phonegap platform
https://github.com/fortunen/cordova-plugin-zeep

angular cordova cordova-android cordova-android-plugin cordova-ios cordova-plugin cordova-plugin-zeep decompression phonegap unzip zip zip-compression

Last synced: 4 days ago
JSON representation

Zip compression/decompression for the cordova/phonegap platform

Awesome Lists containing this project

README

        

# cordova-plugin-zeep
Zip compression/decompression on the [Apache Cordova](https://cordova.apache.org) / [PhoneGap](http://phonegap.com) platform

### Platforms
- ios
- android
- windows

### Add to project
```sh
cordova plugin add cordova-plugin-zeep
```

### Remove from project
```sh
cordova plugin remove cordova-plugin-zeep
```

### Compression (Zeep.zip or $cordovaZeep.zip)
from : [string] the path/url of the folder whose contents you want to compress

to     : [string] the path/url of the zip file that you want to produce

### Decompression (Zeep.unzip or $cordovaZeep.unzip)
from : [string] the path/url of the zip file that you want to decompress

to     : [string] the path/url of the folder in which you want to deposit the contents of the zip file

### Plain JS example
```js
var source = cordova.file.applicationDirectory,
zip = cordova.file.cacheDirectory + 'source.zip',
extracted = cordova.file.cacheDirectory + 'extracted';

console.log('source : ' + source );
console.log('zip : ' + zip );
console.log('extracted : ' + extracted);

console.log('zipping ...');

Zeep.zip({
from : source,
to : zip
}, function() {

console.log('zip success!');
console.log('unzipping ...');

Zeep.unzip({
from : zip,
to : extracted
}, function() {
console.log('unzip success!');
}, function(e) {
console.log('unzip error: ', e);
});

}, function(e) {
console.log('zip error: ', e);
});
```

### [Angular](https://angularjs.org) example
(+ other angular-based frameworks -> Ionic, Mobile Angular UI, LumX, MEAN, Angular Foundation, ...)
```js

var app = angular.module('MyApp', ['ngCordova.plugins.zeep'])

...

app.controller('MyController', function($scope, $cordovaZeep) {

var source = cordova.file.applicationDirectory,
zip = cordova.file.cacheDirectory + 'source.zip',
extracted = cordova.file.cacheDirectory + 'extracted';

console.log('source : ' + source );
console.log('zip : ' + zip );
console.log('extracted : ' + extracted);

console.log('zipping ...');

$cordovaZeep.zip({
from : source,
to : zip
}).then(function() {

console.log('zip success!');
console.log('unzipping ...');

$cordovaZeep.unzip({
from : zip,
to : extracted
}).then(function() {
console.log('unzip success!');
}, function(e) {
console.log('unzip error: ', e);
});

}, function(e) {
console.log('zip error: ', e);
});

});
```

### License
Apache 2.0

### Buy me a beer (maybe)
If you find this plugin useful, perhaps you can buy me a beer :)

[](https://paypal.me/FortuneNgwenya)