@egoist/extract-zip
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.1 • Public • Published

    extract-zip

    Unzip written in pure JavaScript. Extracts a zip into a directory. Available as a library or a command line program.

    Uses the yauzl ZIP parser.

    NPM Uses JS Standard Style Build Status

    Installation

    Make sure you have Node 10 or greater installed.

    Get the library:

    npm install extract-zip --save
    

    Install the command line program:

    npm install extract-zip -g
    

    JS API

    const extract = require('extract-zip')
    
    async main () {
      try {
        await extract(source, { dir: target })
        console.log('Extraction complete')
      } catch (err) {
        // handle any errors
      }
    }

    Options

    • dir (required) - the path to the directory where the extracted files are written
    • defaultDirMode - integer - Directory Mode (permissions), defaults to 0o755
    • defaultFileMode - integer - File Mode (permissions), defaults to 0o644
    • onEntry - function - if present, will be called with (entry, zipfile), entry is every entry from the zip file forwarded from the entry event from yauzl. zipfile is the yauzl instance
    • strip - integer - number of leading directory components to remove from extracted files, defaults to 0

    Default modes are only used if no permissions are set in the zip file.

    CLI Usage

    extract-zip foo.zip <targetDirectory>
    

    If not specified, targetDirectory will default to process.cwd().

    Install

    npm i @egoist/extract-zip

    DownloadsWeekly Downloads

    8

    Version

    2.0.1

    License

    BSD-2-Clause

    Unpacked Size

    11 kB

    Total Files

    7

    Last publish

    Collaborators

    • egoist