Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/araxeus/unarchive
Automatically extract archives of various types
https://github.com/araxeus/unarchive
archive tar targz tgz uncompress zip
Last synced: 22 days ago
JSON representation
Automatically extract archives of various types
- Host: GitHub
- URL: https://github.com/araxeus/unarchive
- Owner: Araxeus
- License: mit
- Created: 2023-03-24T15:15:52.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-09-16T20:18:04.000Z (about 2 months ago)
- Last Synced: 2024-09-17T01:48:44.666Z (about 2 months ago)
- Topics: archive, tar, targz, tgz, uncompress, zip
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/unarchive
- Size: 59.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# unarchive
This tool is a utility wrapper around the [compressing](https://www.npmjs.com/package/compressing) package
it automatically detects the compression type (zip/tar/tar.gz) and extracts the content of the archive
## Installation
```bash
npm install unarchive
```or
```bash
yarn add unarchive
pnpm add unarchive
bun add unarchive
```## Usage
```js
//const unarchive = require('unarchive')
import unarchive from 'unarchive'await unarchive(archiveName, 'outputFolder')
```## Supported formats
- zip
- tar
- tar.gz / tgz