From 703e03aba33f234712206769f57717ba7d92d23d Mon Sep 17 00:00:00 2001 From: LinuxWizard42 Date: Wed, 12 Oct 2022 22:54:37 +0300 Subject: Added export_allowed file to make repository visible in cgit --- node_modules/extract-zip/readme.md | 49 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 49 insertions(+) create mode 100644 node_modules/extract-zip/readme.md (limited to 'node_modules/extract-zip/readme.md') diff --git a/node_modules/extract-zip/readme.md b/node_modules/extract-zip/readme.md new file mode 100644 index 0000000..af17885 --- /dev/null +++ b/node_modules/extract-zip/readme.md @@ -0,0 +1,49 @@ +# 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`](http://npmjs.org/yauzl) ZIP parser. + +[![NPM](https://nodei.co/npm/extract-zip.png?global=true)](https://nodei.co/npm/extract-zip/) +[![js-standard-style](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard) +[![Build Status](https://travis-ci.org/maxogden/extract-zip.svg?branch=master)](https://travis-ci.org/maxogden/extract-zip) + +## Installation + +Get the library: + +``` +npm install extract-zip --save +``` + +Install the command line program: + +``` +npm install extract-zip -g +``` + +## JS API + +```js +var extract = require('extract-zip') +extract(source, {dir: target}, function (err) { + // extraction is complete. make sure to handle the err +}) +``` + +### Options + +- `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 + +Default modes are only used if no permissions are set in the zip file. + +## CLI Usage + +``` +extract-zip foo.zip +``` + +If not specified, `targetDirectory` will default to `process.cwd()`. -- cgit v1.2.3-86-g962b