https://github.com/mborne/node-extract

Extract archives (7z, zip, bz2, gz,...) using system executables
https://github.com/mborne/node-extract

Last synced: 26 days ago
JSON representation

Extract archives (7z, zip, bz2, gz,...) using system executables

• Host: GitHub
• URL: https://github.com/mborne/node-extract
• Owner: mborne
• License: mit
• Created: 2019-06-04T07:16:43.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-09-28T19:37:26.000Z (over 2 years ago)
• Last Synced: 2024-10-19T00:57:09.575Z (3 months ago)
• Language: JavaScript
• Size: 36.1 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# node-extract

[![Node.js CI](https://github.com/mborne/node-extract/actions/workflows/node.js.yml/badge.svg)](https://github.com/mborne/node-extract/actions/workflows/node.js.yml) [![Coverage Status](https://coveralls.io/repos/github/mborne/node-extract/badge.svg?branch=master)](https://coveralls.io/github/mborne/node-extract?branch=master)

## Description

Extract archives (7z, zip, bz2, gz,...) using system executables

## Usage

```js

const extract = require('@mborne/extract');

await extract({

    archivePath: '/path/to/archive.zip'

});

```

## Options

| Name          | Required? | Description                     |     Default      |

| ------------- | :-------: | ------------------------------- | :--------------: |

| `archivePath` |    YES    | Archive path                    |        NA        |

| `targetDir`   |    NO     | Target directory for extraction | Parent directory |

## License

[MIT](LICENSE)