Skip to content

Latest commit

 

History

History
111 lines (93 loc) · 2.05 KB

README.md

File metadata and controls

111 lines (93 loc) · 2.05 KB

angular-ionic-unzip

Provides a simple wrapper using JSZip to unzip a file and save to the local filesystem using ionic-native's File

##Install

npm install angular-ionic-unzip

Add jsZip include to your index.html placing in the assets folder.

<script src="assets/jszip.min.js"></script>

http://github.com/Stuk/jszip/

##Usage

Add IonicUnzip to your app module providers

@NgModule({
    providers:[IonicUnzip]
});

Import it to your class

export class Catalog {

    constructor(private unzipService:IonicUnzip) {
        
        this.unzipService.unzip({
           targetDir: '/images',
           fileName: 'images.zip,     
        }).then(() => {
            //unzip complete
        }).catch((e) => {
            //unzipping failed
            console.log(e);
        });
    
    }

This expects the zip file to already be downloaded on the local file system in the dataDirectory.

Param Type Details
dataDir string

Base FileSystem. Please refer to the iOS and Android filesystems https://ionicframework.com/docs/native/file/ by default it's set to dataDirectory

targetDir string

Target extraction directory

fileName string

Name of the zip file

overwrite boolean

Overwrite existing folders and files, default true

verbose boolean

Log file creation output to the console, default false