# decompress-tarxz

> decompress tar.xz plugin

Latest version **3.0.0** (published 2019-09-06) · MIT license · 0 weekly downloads

## Install

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

## 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 | 3.0.0 |
| Published | 2019-09-06 |
| First published | 2015-03-24 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 4 |
| Unpacked size | 3.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 13 |
| Author | Kevin Mårtensson |
| Maintainers | kevva, sindresorhus |
| Keywords | decompress, decompressplugin, extract, tar, tarxz, xz |

## Links

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

## Dependencies (4)

- [file-type](https://npm.io/package/file-type.md) ^12.3.0
- [is-stream](https://npm.io/package/is-stream.md) ^2.0.0
- [lzma-native](https://npm.io/package/lzma-native.md) ^4.0.5
- [decompress-tar](https://npm.io/package/decompress-tar.md) ^4.1.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

- 3.0.0 (latest) — 2019-09-06
- 2.1.1 — 2017-07-13
- 2.1.0 — 2017-04-25
- 2.0.0 — 2016-05-20
- 1.0.2 — 2015-06-16
- 1.0.1 — 2015-03-24
- 1.0.0 — 2015-03-24

## README

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

> tar.xz decompress plugin


## Install

```
$ npm install decompress-tarxz
```


## Usage

```js
const decompress = require('decompress');
const decompressTarxz = require('decompress-tarxz');

(async () => {
	await decompress('unicorn.tar.xz', 'dist', {
		plugins: [
			decompressTarxz()
		]
	});

	console.log('Files decompressed');
})();
```


## API

### decompressTarxz()(input)

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

#### input

Type: `Buffer` `Stream`

Buffer or stream to decompress.

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