Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(zip): add plugin #4238

Merged
merged 2 commits into from
Jun 30, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
43 changes: 43 additions & 0 deletions src/@awesome-cordova-plugins/plugins/zip/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
import { AwesomeCordovaNativePlugin, Cordova, Plugin } from '@awesome-cordova-plugins/core';

import { Injectable } from '@angular/core';

/**
* @name Zip
* @description
* A Cordova plugin to unzip files in Android and iOS.
* @usage
* ```typescript
* import { Zip } from '@awesome-cordova-plugins/zip/nx'
* ...
*
* const result = await Zip.unzip('path/to/source.zip', 'path/to/dest', (progress) =>
* console.log('Unzipping, ' + Math.round((progress.loaded / progress.total) * 100) + '%')
* );
*
* if(result === 0) console.log('SUCCESS');
* if(result === -1) console.log('FAILED');
*
* ```
*/
@Plugin({
pluginName: 'Zip',
plugin: 'cordova-plugin-zip',
pluginRef: 'zip',
repo: 'https://github.com/MobileChromeApps/cordova-plugin-zip',
platforms: ['Android', 'iOS'],
})
@Injectable()
export class Zip extends AwesomeCordovaNativePlugin {
/**
* Extracts files from a ZIP archive
* @param {string} sourceZip Source ZIP file
* @param {string} destFolder Destination folder
* @param {Function} onProgress optional callback to be called on progress update
* @returns {Promise<number>} returns a promise that resolves with a number. 0 is success, -1 is error
*/
@Cordova()
unzip(sourceZip: string, destFolder: string, onProgress?: Function): Promise<number> {
return;
}
}