1
0
Fork 0
mirror of https://github.com/codedread/bitjs synced 2025-10-03 09:39:16 +02:00

Update some TODOs for a 2.0 release

This commit is contained in:
Jeff Schiller 2024-01-26 09:23:24 -08:00
parent f738d73390
commit b00dc80946
7 changed files with 20 additions and 5 deletions

View file

@ -9,7 +9,7 @@
* Copyright(c) 2011 Google Inc. * Copyright(c) 2011 Google Inc.
*/ */
// TODO: When up-revving to a major new version, remove this module. // TODO(2.0): When up-revving to a major new version, remove this module.
import { UnarchiveAppendEvent, UnarchiveErrorEvent, UnarchiveEvent, UnarchiveEventType, import { UnarchiveAppendEvent, UnarchiveErrorEvent, UnarchiveEvent, UnarchiveEventType,
UnarchiveExtractEvent, UnarchiveFinishEvent, UnarchiveInfoEvent, UnarchiveExtractEvent, UnarchiveFinishEvent, UnarchiveInfoEvent,

View file

@ -10,7 +10,8 @@
import { ZipCompressionMethod, getConnectedPort } from './common.js'; import { ZipCompressionMethod, getConnectedPort } from './common.js';
// NOTE: THIS IS A VERY HACKY WORK-IN-PROGRESS! THE API IS NOT FROZEN! USE AT YOUR OWN RISK! // TODO(2.0): Remove this comment.
// NOTE: THIS IS A WORK-IN-PROGRESS! THE API IS NOT FROZEN! USE AT YOUR OWN RISK!
/** /**
* @typedef FileInfo An object that is sent to the implementation to represent a file to zip. * @typedef FileInfo An object that is sent to the implementation to represent a file to zip.
@ -52,8 +53,8 @@ export const CompressStatus = {
/** /**
* A thing that zips files. * A thing that zips files.
* NOTE: THIS IS A VERY HACKY WORK-IN-PROGRESS! THE API IS NOT FROZEN! USE AT YOUR OWN RISK! * NOTE: THIS IS A WORK-IN-PROGRESS! THE API IS NOT FROZEN! USE AT YOUR OWN RISK!
* TODO: Make a streaming / event-driven API. * TODO(2.0): Add semantic onXXX methods for an event-driven API.
*/ */
export class Zipper { export class Zipper {
/** /**

View file

@ -15,7 +15,7 @@ import { getConnectedPort } from './common.js';
import { findMimeType } from '../file/sniffer.js'; import { findMimeType } from '../file/sniffer.js';
// Exported as a convenience (and also because this module used to contain these). // Exported as a convenience (and also because this module used to contain these).
// TODO(bitjs): Remove this export in a future release? // TODO(2.0): Remove this export, since they have moved to events.js.
export { export {
UnarchiveAppendEvent, UnarchiveAppendEvent,
UnarchiveErrorEvent, UnarchiveErrorEvent,
@ -288,6 +288,8 @@ export class Untarrer extends Unarchiver {
getScriptFileName() { return './untar.js'; }; getScriptFileName() { return './untar.js'; };
} }
// TODO(2.0): When up-revving to a major new version, remove the string type for options.
/** /**
* Factory method that creates an unarchiver based on the byte signature found * Factory method that creates an unarchiver based on the byte signature found
* in the ArrayBuffer. * in the ArrayBuffer.

View file

@ -6,6 +6,12 @@
* Copyright(c) 2023 Google Inc. * Copyright(c) 2023 Google Inc.
*/ */
// TODO(2.0): Consider deprecating the Event subclasses here and:
// 1) Make @typedef structures in jsdoc for all the payloads
// 2) Use CustomEvent for payload event propagation
// 3) Add semantic methods to the archivers (onExtract, onProgress) like the image parsers.
// 4) Move everything into common.js ?
/** /**
* The UnarchiveEvent types. * The UnarchiveEvent types.
*/ */

View file

@ -20,3 +20,5 @@ Assuming you have cloned the repository in /path/to/bitjs:
Various library files will be output to /path/to/bitjs/. For example, the Various library files will be output to /path/to/bitjs/. For example, the
/path/to/bitjs/image/webp-shim/ directory will now contain update webp-shim-module.js and /path/to/bitjs/image/webp-shim/ directory will now contain update webp-shim-module.js and
webp-shim-module.wasm files. webp-shim-module.wasm files.
# TODO(2.0): Remove this.

View file

@ -9,6 +9,8 @@
* Copyright(c) 2020 Google Inc. * Copyright(c) 2020 Google Inc.
*/ */
// TODO(2.0): Remove this. It seems unnecessary given WebP is universally supported now.
#include <stdio.h> #include <stdio.h>
#include <stdlib.h> #include <stdlib.h>
#include "emscripten.h" #include "emscripten.h"

View file

@ -6,6 +6,8 @@
* Copyright(c) 2020 Google Inc. * Copyright(c) 2020 Google Inc.
*/ */
// TODO(2.0): Remove this. It seems unnecessary given WebP is universally supported now.
const url = import.meta.url; const url = import.meta.url;
if (!url.endsWith('/webp-shim.js')) { if (!url.endsWith('/webp-shim.js')) {
throw 'webp-shim must be loaded as webp-shim.js'; throw 'webp-shim must be loaded as webp-shim.js';