extract-zip-promise

Wrapper arount extract-zip enabling promise interface.

Usage no npm install needed!

<script type="module">
  import extractZipPromise from 'https://cdn.skypack.dev/extract-zip-promise';
</script>

README

Extract Zip Promise

Simple wrapper around extract-zip module, enabling promise interface.

CircleCI GitHub dependabot enabled

Installation

npm i extract-zip-promise

Usage

const extractZip = require("extract-zip-promise")
  //
;(async () => {
  try {
    await extractZip(archivePath, { dir: "destination/path" })
  } catch (e) {
    //error extracting zip file
  }
})()

Function signature is the same as extract-zip module.

Options object

  • dir - defaults to process.cwd()
  • defaultDirMode - integer - Directory Mode (permissions) will default to 493 (octal 0755 in integer)
  • defaultFileMode - integer - File Mode (permissions) will default to 420 (octal 0644 in integer)
  • 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