# tar-mini

> It's an implementation based on the `ustar` format

Latest version **0.2.0** (published 2024-09-05) · MIT license · 0 weekly downloads

## Install

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

## Health

**Score 35/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; has provenance; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.0 |
| Published | 2024-09-05 |
| First published | 2024-08-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 30.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Provenance | attested (GitHub Actions) |
| GitHub stars | 9 |
| Author | Kanno |
| Maintainers | nonzzz |
| Keywords | archive, tar, pack, extract, ustar |

## Links

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

## 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) — 2024-09-05
- 0.1.4 — 2024-09-02
- 0.1.3 — 2024-09-02
- 0.1.2 — 2024-09-01
- 0.1.1 — 2024-08-26
- 0.1.0 — 2024-08-14

## README

# TarMini

It's an implementation based on the `ustar` format. This package only provides low-level API's.

### Usage

```ts
// packing
import { createPack, createExtract } from 'tar-mini'

const pack = createPack()

pack.add(new Uint8Array(512), {
  // options
})

pack.done()

// extracting

const extract = createExtract()

extract.on('entry', (head, file) => {
  // todo
})

pack.receiver.pipe(extract.receiver)
```

### Sponsors

<p align="center">
  <a href="https://cdn.jsdelivr.net/gh/nonzzz/sponsors/sponsorkit/sponsors.svg">
    <img src="https://cdn.jsdelivr.net/gh/nonzzz/sponsors/sponsorkit/sponsors.svg"/>
  </a>
</p>

### Related

- [tar](https://www.gnu.org/software/tar/manual/html_node/Standard.html)

### LICENSE

[MIT](./LICENSE)

### Author

Kanno

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