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

For issue #47, add semantic event handlers to Unarchiver (onProgress, onExtract)

Browse source
This commit is contained in:
Jeff Schiller 2024-02-03 13:12:30 -08:00
parent 675512cf84
commit ede9c6aafa
3 changed files with 43 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

39
archive/decompress.js
View file

@ -15,7 +15,7 @@ import { getConnectedPort } from './common.js';
import { findMimeType } from '../file/sniffer.js';
// Exported as a convenience (and also because this module used to contain these).
// TODO(2.0): Remove this export, since they have moved to events.js.
// TODO(2.0): Remove this export, since they have moved to events.js?
export {
UnarchiveAppendEvent,
UnarchiveErrorEvent,
@ -31,6 +31,7 @@ export {
/**
* All extracted files returned by an Unarchiver will implement
* the following interface:
* TODO: Move this interface into common.js?
*/
/**
@ -49,7 +50,7 @@ export {
*/
export class Unarchiver extends EventTarget {
/**
* The client-side port that sends messages to, and receives messages from the
* The client-side port that sends messages to, and receives messages from, the
* decompressor implementation.
* @type {MessagePort}
* @private
@ -74,6 +75,7 @@ export class Unarchiver extends EventTarget {
constructor(arrayBuffer, options = {}) {
super();
// TODO(2.0): Remove this.
if (typeof options === 'string') {
console.warn(`Deprecated: Don't send a raw string to Unarchiver()`);
console.warn(` send UnarchiverOptions instead.`);
@ -95,7 +97,7 @@ export class Unarchiver extends EventTarget {
}
/**
* Overridden so that the type hints for eventType are specific.
* Overridden so that the type hints for eventType are specific. Prefer onExtract(), etc.
* @param {'progress'|'extract'|'finish'} eventType
* @param {EventListenerOrEventListenerObject} listener
* @override
@ -104,6 +106,36 @@ export class Unarchiver extends EventTarget {
super.addEventListener(eventType, listener);
}
/**
* Type-safe way to subscribe to an UnarchiveExtractEvent.
* @param {function(UnarchiveExtractEvent)} listener
* @returns {Unarchiver} for chaining.
*/
onExtract(listener) {
super.addEventListener(UnarchiveEventType.EXTRACT, listener);
return this;
}
/**
* Type-safe way to subscribe to an UnarchiveFinishEvent.
* @param {function(UnarchiveFinishEvent)} listener
* @returns {Unarchiver} for chaining.
*/
onFinish(listener) {
super.addEventListener(UnarchiveEventType.FINISH, listener);
return this;
}
/**
* Type-safe way to subscribe to an UnarchiveProgressEvent.
* @param {function(UnarchiveProgressEvent)} listener
* @returns {Unarchiver} for chaining.
*/
onProgress(listener) {
super.addEventListener(UnarchiveEventType.PROGRESS, listener);
return this;
}
/**
* This method must be overridden by the subclass to return the script filename.
* @returns {string} The MIME type of the archive.
@ -154,7 +186,6 @@ export class Unarchiver extends EventTarget {
/**
* Receive an event and pass it to the listener functions.
*
* @param {Object} obj
* @returns {boolean} Returns true if the decompression is finished.
* @private