https://github.com/gera2ld/tarjs
https://github.com/gera2ld/tarjs
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/gera2ld/tarjs
- Owner: gera2ld
- License: mit
- Created: 2021-03-09T04:42:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2023-10-21T05:28:50.000Z (almost 3 years ago)
- Last Synced: 2025-04-15T06:43:28.666Z (over 1 year ago)
- Language: TypeScript
- Homepage: https://www.jsdocs.io/package/@gera2ld/tarjs
- Size: 224 KB
- Stars: 10
- Watchers: 2
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# @gera2ld/tarjs
A zero-dependency JavaScript library to read and write tar files.
## Features
- reading and writing
- UTF-8 support for filenames and contents
- no dependency, with support for Node.js, browsers, Deno
## Limitations
- File name (including path) has to be less than 100 characters
- Maximum total file size seems to be limited to somewhere between 500MB to 1GB (exact limit is unknown)
## Usage
```js
// ESM
import { TarReader, TarWriter } from '@gera2ld/tarjs';
// IIFE
const { TarReader, TarWriter } = window.tarjs;
const reader = await TarReader.load(tarFile);
console.log('Loaded items:', reader.fileInfos);
```
Check [jsdoc](https://www.jsdocs.io/package/@gera2ld/tarjs) for API reference.
## Credits
- [ankitrohatgi/tarballjs](https://github.com/ankitrohatgi/tarballjs)
- [Basic Tar Format](https://www.gnu.org/software/tar/manual/html_node/Standard.html)