# decompress-tar

> decompress tar plugin

Latest version **4.1.1** (published 2017-07-27) · MIT license · 0 weekly downloads

## Install

```sh
npm install decompress-tar
pnpm add decompress-tar
yarn add decompress-tar
bun add decompress-tar
```

## Health

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

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 4.1.1 |
| Published | 2017-07-27 |
| First published | 2014-06-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4 |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 16 |
| Author | Kevin Mårtensson |
| Maintainers | kevva |
| Keywords | decompress, decompressplugin, extract, tar |

## Links

- npm: https://www.npmjs.com/package/decompress-tar
- Repository: https://github.com/kevva/decompress-tar
- Homepage: https://github.com/kevva/decompress-tar#readme
- Issues: https://github.com/kevva/decompress-tar/issues
- npm.io page: https://npm.io/package/decompress-tar

## Dependencies (3)

- [file-type](https://npm.io/package/file-type.md) ^5.2.0
- [is-stream](https://npm.io/package/is-stream.md) ^1.1.0
- [tar-stream](https://npm.io/package/tar-stream.md) ^1.5.2

## 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

- 4.1.1 (latest) — 2017-07-27
- 4.1.0 — 2016-05-24
- 4.0.0 — 2016-05-20
- 3.1.0 — 2015-03-24
- 3.0.0 — 2015-03-09
- 2.0.2 — 2014-09-16
- 2.0.1 — 2014-09-15
- 2.0.0 — 2014-09-13
- 1.0.3 — 2014-09-05
- 1.0.2 — 2014-08-27
- 1.0.1 — 2014-08-19
- 1.0.0 — 2014-08-15
- 0.1.1 — 2014-06-13
- 0.1.0 — 2014-06-13

## README

# decompress-tar [![Build Status](https://travis-ci.org/kevva/decompress-tar.svg?branch=master)](https://travis-ci.org/kevva/decompress-tar)

> tar decompress plugin


## Install

```
$ npm install decompress-tar
```


## Usage

```js
const decompress = require('decompress');
const decompressTar = require('decompress-tar');

decompress('unicorn.tar', 'dist', {
	plugins: [
		decompressTar()
	]
}).then(() => {
	console.log('Files decompressed');
});
```


## API

### decompressTar()(input)

Returns both a Promise for a Buffer and a [Duplex stream](https://nodejs.org/api/stream.html#stream_class_stream_duplex).

#### input

Type: `Buffer` `Stream`

Buffer or stream to decompress.


## License

MIT © [Kevin Mårtensson](https://github.com/kevva)

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