https://github.com/sgtlambda/extrakt
Extract .tar(.gz) using the system binary (fast!), with a javascript fallback (portable!)
https://github.com/sgtlambda/extrakt
extract nodejs tar
Last synced: about 1 year ago
JSON representation
Extract .tar(.gz) using the system binary (fast!), with a javascript fallback (portable!)
- Host: GitHub
- URL: https://github.com/sgtlambda/extrakt
- Owner: sgtlambda
- Created: 2016-01-06T01:29:47.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2022-02-11T00:47:21.000Z (over 4 years ago)
- Last Synced: 2025-03-19T09:39:45.696Z (about 1 year ago)
- Topics: extract, nodejs, tar
- Language: JavaScript
- Homepage:
- Size: 520 KB
- Stars: 18
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# [](https://github.com/sgtlambda/extrakt)
> Extract `.tar` and `.tar.gz` using the system binary (fast!), with a javascript fallback (portable!)
Makes a great team with [nectar](https://github.com/sgtlambda/nectar).
[![Build Status][travis-image]][travis-url]
[![NPM Version][npm-image]][npm-url]
## Install
```
$ npm install --save extrakt
```
## Usage
```js
const extrakt = require('extrakt');
extrakt('path/to/archive.tar.gz', 'output/directory');
```
## API
### extrakt(archive, extractTo)
Extract the archive at the given `archive` path to the `extractTo` directory.
**Returns** a Promise for the completion of the extraction.
#### archive
Type: `string`
Path to the archive
#### extractTo
Type: `string`
Destination directory
## License
MIT © [sgtlambda](http://github.com/sgtlambda)
[travis-image]: https://img.shields.io/travis/sgtlambda/extrakt.svg?style=flat-square
[travis-url]: https://travis-ci.org/sgtlambda/extrakt
[npm-image]: https://img.shields.io/npm/v/extrakt.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/extrakt