1
0
Fork 0
mirror of https://github.com/codedread/bitjs synced 2025-10-05 18:34:17 +02:00

Tweak README for 1.2.2 release

This commit is contained in:
Jeff Schiller 2024-01-26 17:14:10 -08:00
parent 08a0fd8e6c
commit 675512cf84
3 changed files with 20 additions and 21 deletions

View file

@ -20,12 +20,6 @@ import { ZipCompressionMethod, getConnectedPort } from './common.js';
* @property {Uint8Array} fileData The bytes of the file.
*/
// export const DeflateCompressionMethod = {
// NO_COMPRESSION: 0,
// COMPRESSION_FIXED_HUFFMAN: 1,
// COMPRESSION_DYNAMIC_HUFFMAN: 2,
// }
/**
* Data elements are packed into bytes in order of increasing bit number within the byte,
* i.e., starting with the least-significant bit of the byte.
@ -51,6 +45,10 @@ export const CompressStatus = {
ERROR: 'error',
};
// TODO: Extend EventTarget and introduce subscribe methods (onProgress, onInsert, onFinish, etc).
// TODO: I think appendFiles() is still a good idea so that all files do not have to live in memory
// at once, but the API is wonky here... re-think it. Maybe something more like a builder?
/**
* A thing that zips files.
* NOTE: THIS IS A WORK-IN-PROGRESS! THE API IS NOT FROZEN! USE AT YOUR OWN RISK!