From 1fab6b1c16d8dc50f740f545d26a9eae39ec1750 Mon Sep 17 00:00:00 2001 From: Jeff Schiller Date: Sat, 3 Feb 2024 14:25:11 -0800 Subject: [PATCH] Updates types after adding onExtract, etc --- CHANGELOG.md | 3 +++ types/archive/decompress.d.ts | 24 +++++++++++++++++++++--- types/archive/decompress.d.ts.map | 2 +- 3 files changed, 25 insertions(+), 4 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 7b161d2..1fe12e6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -8,6 +8,9 @@ All notable changes to this project will be documented in this file. - archive: Support semantic methods for subscribing to unarchive events (onExtract), [Issue #47](https://github.com/codedread/bitjs/issues/47). +### Changed + +- archive: Error on RAR5 files. ## [1.2.2] - 2024-01-26 diff --git a/types/archive/decompress.d.ts b/types/archive/decompress.d.ts index d6f8843..ebaa1c9 100644 --- a/types/archive/decompress.d.ts +++ b/types/archive/decompress.d.ts @@ -13,6 +13,7 @@ export function getUnarchiver(ab: ArrayBuffer, options?: UnarchiverOptions | str /** * All extracted files returned by an Unarchiver will implement * the following interface: + * TODO: Move this interface into common.js? */ /** * @typedef UnarchivedFile @@ -37,7 +38,7 @@ export class Unarchiver extends EventTarget { */ constructor(arrayBuffer: ArrayBuffer, options?: UnarchiverOptions | string); /** - * 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 @@ -61,12 +62,30 @@ export class Unarchiver extends EventTarget { */ debugMode_: boolean; /** - * 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 */ override addEventListener(eventType: 'progress' | 'extract' | 'finish', listener: EventListenerOrEventListenerObject): void; + /** + * Type-safe way to subscribe to an UnarchiveExtractEvent. + * @param {function(UnarchiveExtractEvent)} listener + * @returns {Unarchiver} for chaining. + */ + onExtract(listener: (arg0: UnarchiveExtractEvent) => any): Unarchiver; + /** + * Type-safe way to subscribe to an UnarchiveFinishEvent. + * @param {function(UnarchiveFinishEvent)} listener + * @returns {Unarchiver} for chaining. + */ + onFinish(listener: (arg0: UnarchiveFinishEvent) => any): Unarchiver; + /** + * Type-safe way to subscribe to an UnarchiveProgressEvent. + * @param {function(UnarchiveProgressEvent)} listener + * @returns {Unarchiver} for chaining. + */ + onProgress(listener: (arg0: UnarchiveProgressEvent) => any): Unarchiver; /** * This method must be overridden by the subclass to return the script filename. * @returns {string} The MIME type of the archive. @@ -88,7 +107,6 @@ export class Unarchiver extends EventTarget { private createUnarchiveEvent_; /** * Receive an event and pass it to the listener functions. - * * @param {Object} obj * @returns {boolean} Returns true if the decompression is finished. * @private diff --git a/types/archive/decompress.d.ts.map b/types/archive/decompress.d.ts.map index 934b2d1..ada8dff 100644 --- a/types/archive/decompress.d.ts.map +++ b/types/archive/decompress.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"decompress.d.ts","sourceRoot":"","sources":["../../archive/decompress.js"],"names":[],"mappings":"AAoSA;;;;;;;;;;GAUG;AACH,kCARW,WAAW,YAGX,iBAAiB,GAAC,MAAM,GAGtB,UAAU,CAkBtB;AAjSD;;;GAGG;AAEH;;;;GAIG;AAEH;;;GAGG;AAEH;;GAEG;AACH;IAgBE;;;;;;;OAOG;IACH,yBAPW,WAAW,YAGX,iBAAiB,GAAC,MAAM,EAyBlC;IA5CD;;;;;OAKG;IACH,cAAM;IAEN;;;;OAIG;IACH,sBAAc;IAmBZ;;;;OAIG;IACH,cAHU,WAAW,CAGA;IAErB;;;OAGG;IACH,YAFU,OAAO,CAEkB;IAGrC;;;;;OAKG;IACH,qCAJW,UAAU,GAAC,SAAS,GAAC,QAAQ,YAC7B,kCAAkC,QAK5C;IAED;;;;OAIG;IACH,yBAHa,MAAM,CAKlB;IAED;;;;OAIG;IACH,+BAHa,MAAM,CAKlB;IAED;;;;;OAKG;IACH,8BAsBC;IAED;;;;;;OAMG;IACH,yBAaC;IAED;;;;;OAKG;IACH,SAJa,QAAQ,IAAI,CAAC,CAgCzB;IAGD;;;;;;;;OAQG;IACH,WAPW,WAAW,qBAGX,OAAO,oBAgBjB;IAED;;OAEG;IACH,aAOC;CACF;AAID;IACE;;;OAGG;IACH,gBAHW,WAAW,YACX,iBAAiB,EAI3B;CAIF;AAED;IACE;;;OAGG;IACH,gBAHW,WAAW,YACX,iBAAiB,EAI3B;CAIF;AAED;IACE;;;OAGG;IACH,gBAHW,WAAW,YACX,iBAAiB,EAI3B;CAIF;;cA3Pa,MAAM;cACN,UAAU;;;;;;YAKV,OAAO"} \ No newline at end of file +{"version":3,"file":"decompress.d.ts","sourceRoot":"","sources":["../../archive/decompress.js"],"names":[],"mappings":"AAmUA;;;;;;;;;;GAUG;AACH,kCARW,WAAW,YAGX,iBAAiB,GAAC,MAAM,GAGtB,UAAU,CAkBtB;AAhUD;;;;GAIG;AAEH;;;;GAIG;AAEH;;;GAGG;AAEH;;GAEG;AACH;IAgBE;;;;;;;OAOG;IACH,yBAPW,WAAW,YAGX,iBAAiB,GAAC,MAAM,EA0BlC;IA7CD;;;;;OAKG;IACH,cAAM;IAEN;;;;OAIG;IACH,sBAAc;IAoBZ;;;;OAIG;IACH,cAHU,WAAW,CAGA;IAErB;;;OAGG;IACH,YAFU,OAAO,CAEkB;IAGrC;;;;;OAKG;IACH,qCAJW,UAAU,GAAC,SAAS,GAAC,QAAQ,YAC7B,kCAAkC,QAK5C;IAED;;;;OAIG;IACH,2BAHoB,qBAAqB,WAC5B,UAAU,CAKtB;IAED;;;;OAIG;IACH,0BAHoB,oBAAoB,WAC3B,UAAU,CAKtB;IAED;;;;OAIG;IACH,4BAHoB,sBAAsB,WAC7B,UAAU,CAKtB;IAED;;;;OAIG;IACH,yBAHa,MAAM,CAKlB;IAED;;;;OAIG;IACH,+BAHa,MAAM,CAKlB;IAED;;;;;OAKG;IACH,8BAsBC;IAED;;;;;OAKG;IACH,yBAaC;IAED;;;;;OAKG;IACH,SAJa,QAAQ,IAAI,CAAC,CAgCzB;IAGD;;;;;;;;OAQG;IACH,WAPW,WAAW,qBAGX,OAAO,oBAgBjB;IAED;;OAEG;IACH,aAOC;CACF;AAID;IACE;;;OAGG;IACH,gBAHW,WAAW,YACX,iBAAiB,EAI3B;CAIF;AAED;IACE;;;OAGG;IACH,gBAHW,WAAW,YACX,iBAAiB,EAI3B;CAIF;AAED;IACE;;;OAGG;IACH,gBAHW,WAAW,YACX,iBAAiB,EAI3B;CAIF;;cAzRa,MAAM;cACN,UAAU;;;;;;YAKV,OAAO"} \ No newline at end of file