yetangitu/bitjs
1
0
Fork 0
mirror of https://github.com/codedread/bitjs synced 2025-10-06 02:39:55 +02:00
Code Issues Releases Wiki Activity

Update docs in prep for 1.2.2 release

Browse source
This commit is contained in:
Jeff Schiller 2024-01-25 23:27:09 -08:00
parent e03fe7c483
commit f738d73390
3 changed files with 8 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -2,7 +2,7 @@
All notable changes to this project will be documented in this file. All notable changes to this project will be documented in this file.
## [1.2.2] - 2024-01-?? ## [1.2.2] - 2024-01-26
### Added ### Added

4
README.md
View file

@ -48,8 +48,8 @@ const { getFullMIMEString } = await import('@codedread/bitjs');
### bitjs.archive ### bitjs.archive
This package includes objects for unarchiving binary data in popular archive formats (zip, rar, tar). This package includes objects for decompressing binary data in popular archive formats (zip, rar,
Here is a simple example of unrar: tar). Here is a simple example of unrar:
#### Decompressing #### Decompressing

7
docs/bitjs.archive.md
View file

@ -4,8 +4,11 @@ This package includes objects for unarchiving binary data in popular archive for
providing unzip, unrar and untar capabilities via JavaScript in the browser or various JavaScript providing unzip, unrar and untar capabilities via JavaScript in the browser or various JavaScript
runtimes (node, deno, bun). runtimes (node, deno, bun).
A prototype version of a compressor that creates Zip files is also present. The decompression / A prototype version of a compressor that creates Zip files is also present.
compression happens inside a Web Worker, if the runtime supports it (browsers, deno).
The decompression / compression happens inside a Web Worker, if the runtime supports it (browsers,
deno). The library uses native decompression, if supported by the browser
(via [DecompressionStream](https://developer.mozilla.org/en-US/docs/Web/API/DecompressionStream/DecompressionStream)), and falls back to JavaScript implementations otherwise.
The API is event-based, you will want to subscribe to some of these events: The API is event-based, you will want to subscribe to some of these events:
* 'progress': Periodic updates on the progress (bytes processed). * 'progress': Periodic updates on the progress (bytes processed).