https://github.com/ankitrohatgi/tarballjs
Javascript library to create or read tar files in the browser
https://github.com/ankitrohatgi/tarballjs
javascript javascript-library tar tar-archive tarball
Last synced: 5 months ago
JSON representation
Javascript library to create or read tar files in the browser
- Host: GitHub
- URL: https://github.com/ankitrohatgi/tarballjs
- Owner: ankitrohatgi
- License: mit
- Created: 2017-09-05T00:19:51.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-04-25T05:55:22.000Z (over 1 year ago)
- Last Synced: 2025-04-04T03:51:03.339Z (6 months ago)
- Topics: javascript, javascript-library, tar, tar-archive, tarball
- Language: JavaScript
- Homepage:
- Size: 51.8 KB
- Stars: 61
- Watchers: 2
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tarballjs
Javascript library to create or read tar files in the browser
## Why?
It is often necessary to pack data into single files in the browser (e.g. creating a "project" file consisting of images+data in WebPlotDigitizer). One way is to create simple tarballs with all the data. There are a few existing libraries that do this, but this seems easy enough to do so I decided to do make my own library for learning purposes.
## Status
Refer to https://www.npmjs.com/package/@gera2ld/tarjs for a better maintained version of this code. This code is mainly used to support WebPlotDigitizer.
There are a few known limitations with this library:
- Browser only, no support for NodeJS.
- 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).
Some benefits of using this library:
- Code is a lot cleaner than most other implementations that I can find.
- Unit tests for read and write.
## Browser Support
This works fine on any recent version of Chrome, Firefox or Safari.
## Running Unit Tests
For Chrome, the test page has to be hosted on a HTTP server. An easy way is to use Python:
In the root directory of this project, do:
python3 -m http.server 8000
Then browse to http://localhost:8000/tests/
In Firefox, you can simply load tests/index.html without starting a web server.
## Other Implementations
- https://github.com/beatgammit/tar-js
- https://github.com/chriswininger/jstar
- https://github.com/InvokIT/js-untar (reading only)
- https://github.com/workhorsy/uncompress.js (reading only)
- http://stuk.github.io/jszip/ (active and well maintained project but for .zip files)
If you are aware of other implementations, then please let me know :)
## References
- https://en.wikipedia.org/wiki/Tar_(computing)
- https://www.gnu.org/software/tar/manual/html_node/Standard.html