# @xingrz/decompress-tarzst

> Decompress tar.zst plugin

Latest version **5.2.0-alpha.0** (published 2021-11-13) · MIT license · 0 weekly downloads

## Install

```sh
npm install @xingrz/decompress-tarzst
pnpm add @xingrz/decompress-tarzst
yarn add @xingrz/decompress-tarzst
bun add @xingrz/decompress-tarzst
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 5.2.0-alpha.0 |
| Published | 2021-11-13 |
| First published | 2021-11-01 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Node | >=10 |
| Dependencies | 5 |
| Unpacked size | 6.3 KB |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 0 |
| Author | XiNGRZ |
| Maintainers | xingrz |
| Keywords | decompress, decompressplugin, extract, tar, tar.zst, tarzst, zst, zstd |

## Links

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

## Dependencies (5)

- [file-type](https://npm.io/package/file-type.md) ^16.5.3
- [is-stream](https://npm.io/package/is-stream.md) ^2.0.1
- [@xingrz/cppzst](https://npm.io/package/@xingrz/cppzst.md) ^2.1.0-alpha.8
- [@xingrz/decompress-tar](https://npm.io/package/@xingrz/decompress-tar.md) ^5.2.0-alpha.0
- [@xingrz/decompress-types](https://npm.io/package/@xingrz/decompress-types.md) ^5.2.0-alpha.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

- 5.2.0-alpha.0 (latest) — 2021-11-13
- 5.1.0-alpha.3 — 2021-11-13
- 5.1.0-alpha.2 — 2021-11-13
- 5.1.0-alpha.1 — 2021-11-12
- 5.1.0-alpha.0 — 2021-11-11
- 1.4.0 — 2021-11-11
- 1.3.1 — 2021-11-03
- 1.3.0 — 2021-11-03
- 1.2.0 — 2021-11-02
- 1.1.0 — 2021-11-01
- 1.0.1 — 2021-11-01
- 1.0.0 — 2021-11-01

## README

@xingrz/decompress-tarzst [![test](https://github.com/xingrz/decompress-tarzst/actions/workflows/test.yml/badge.svg)](https://github.com/xingrz/decompress-tarzst/actions/workflows/test.yml)
==========

[![][npm-version]][npm-url] [![][npm-downloads]][npm-url] [![license][license-img]][license-url] [![issues][issues-img]][issues-url] [![stars][stars-img]][stars-url] [![commits][commits-img]][commits-url]

[@xingrz/decompress](https://github.com/xingrz/decompress) .tar.zst plugin.

## Install

```sh
npm install --save @xingrz/decompress-tarzst
```

## Usage

```ts
import decompress from '@xingrz/decompress';
import decompressTarzst from '@xingrz/decompress-tarzst';

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

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

## API

### `decompressTarzst(): (input: Buffer | Readable) => Promise<File[]>`

Returns a `Promise<File[]>`.

#### input

Type: `Buffer` or [`stream.Readable`](https://nodejs.org/dist/latest-v16.x/docs/api/stream.html#class-streamreadable)

Buffer or stream to decompress.

## License

[MIT License](LICENSE)

[npm-version]: https://img.shields.io/npm/v/@xingrz/decompress-tarzst.svg?style=flat-square
[npm-downloads]: https://img.shields.io/npm/dm/@xingrz/decompress-tarzst.svg?style=flat-square
[npm-url]: https://www.npmjs.com/package/@xingrz/decompress-tarzst
[license-img]: https://img.shields.io/github/license/xingrz/decompress-tarzst?style=flat-square
[license-url]: LICENSE
[issues-img]: https://img.shields.io/github/issues/xingrz/decompress-tarzst?style=flat-square
[issues-url]: https://github.com/xingrz/decompress-tarzst/issues
[stars-img]: https://img.shields.io/github/stars/xingrz/decompress-tarzst?style=flat-square
[stars-url]: https://github.com/xingrz/decompress-tarzst/stargazers
[commits-img]: https://img.shields.io/github/last-commit/xingrz/decompress-tarzst?style=flat-square
[commits-url]: https://github.com/xingrz/decompress-tarzst/commits/master

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