# node-targz

> Simple gzip compression and decompression library for Node.js

Latest version **0.2.0** (published 2016-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install node-targz
pnpm add node-targz
yarn add node-targz
bun add node-targz
```

## Health

**Score 23/100 (F)** — status: abandoned.

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2016-11-21 |
| First published | 2014-11-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/node-targz) |
| Module format | CommonJS |
| Node | >= 0.10.0 |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | lafin |
| Maintainers | lafin |
| Keywords | compression, decompression, compress, decompress, tar, tape archive, tape, archive, gzip, gz |

## Links

- npm: https://www.npmjs.com/package/node-targz
- Repository: https://github.com/lafin/node-targz
- Homepage: https://github.com/lafin/node-targz#readme
- Issues: https://github.com/lafin/node-targz/issues
- npm.io page: https://npm.io/package/node-targz

## Dependencies (1)

- [tar-fs](https://npm.io/package/tar-fs.md) ^1.14.0

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 0.2.0 (latest) — 2016-11-21
- 0.1.2 — 2016-07-08
- 0.1.1 — 2016-07-08
- 0.1.0 — 2016-07-07
- 0.0.3 — 2014-11-15
- 0.0.2 — 2014-11-15
- 0.0.1 — 2014-11-15

## README

### Simple gzip compression and decompression utility for Node.js
___

### Installation

```bash
$ npm install node-targz
```

### Example
```js
var tarGzip = require('node-targz');

tarGzip.compress({
    source: '../example',
    destination: '../example.tar.gz',
    level: 6, // optional
    memLevel: 6, // optional
    options: { // options from https://github.com/mafintosh/tar-fs
        entries: ['test.txt']
    }
}, function () {
    tarGzip.decompress({
        source: '../example.tar.gz',
        destination: './unpack-example'
    }, function () {
        console.log('done');
    });
});
```

### Contributors

 * Author: [lafin](https://github.com/lafin)

### License

  [MIT](LICENSE)

---
_Source: https://npm.io/package/node-targz · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._