From fc0381b4d268bbc132ece1d9a4427ed37b302b18 Mon Sep 17 00:00:00 2001 From: Jeff Schiller Date: Sat, 11 Mar 2023 08:50:22 -0800 Subject: [PATCH] Update Typescript type definitions --- package.json | 3 +- types/archive/archive.d.ts.map | 2 +- types/archive/decompress-internal.d.ts | 32 ++-------------------- types/archive/decompress-internal.d.ts.map | 2 +- types/codecs/codecs.d.ts | 6 ++-- types/codecs/codecs.d.ts.map | 2 +- types/file/sniffer.d.ts.map | 2 +- types/io/bitstream.d.ts | 3 ++ types/io/bitstream.d.ts.map | 2 +- 9 files changed, 16 insertions(+), 38 deletions(-) diff --git a/package.json b/package.json index 85d9428..e0fd33e 100644 --- a/package.json +++ b/package.json @@ -47,6 +47,7 @@ "scripts": { "build-webpshim": "cd build; make", "coverage": "./node_modules/.bin/c8 npm test", - "test": "./node_modules/.bin/mocha tests/*.spec.js" + "test": "./node_modules/.bin/mocha tests/*.spec.js", + "update-types": "tsc" } } diff --git a/types/archive/archive.d.ts.map b/types/archive/archive.d.ts.map index 0ff66e4..278860a 100644 --- a/types/archive/archive.d.ts.map +++ b/types/archive/archive.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"archive.d.ts","sourceRoot":"","sources":["../../archive/archive.js"],"names":[],"mappings":"AA0EA;;;;;;;;;GASG;AACH,kCAPW,WAAW,YAGX,MAAO,MAAM,GAEX,UAAU,CAItB;AAxBD;IACE,mCAAgE;CACjE;AAED;IACE,mCAAgE;CACjE;AAED;IACE,mCAAgE;CACjE;;cAjCa,MAAM;cACN,UAAU"} \ No newline at end of file +{"version":3,"file":"archive.d.ts","sourceRoot":"","sources":["../../archive/archive.js"],"names":[],"mappings":"AA4EA;;;;;;;;;GASG;AACH,kCAPW,WAAW,YAGX,MAAO,MAAM,GAEX,UAAU,CAKtB;AAzBD;IACE,mCAAwE;CACzE;AAED;IACE,mCAAwE;CACzE;AAED;IACE,mCAAwE;CACzE;;cArCa,MAAM;cACN,UAAU"} \ No newline at end of file diff --git a/types/archive/decompress-internal.d.ts b/types/archive/decompress-internal.d.ts index dba2bf9..afa8a95 100644 --- a/types/archive/decompress-internal.d.ts +++ b/types/archive/decompress-internal.d.ts @@ -20,16 +20,11 @@ export namespace UnarchiveEventType { /** * An unarchive event. */ -export class UnarchiveEvent { +export class UnarchiveEvent extends Event { /** * @param {string} type The event type. */ constructor(type: string); - /** - * The event type. - * @type {string} - */ - type: string; } /** * Updates all Archiver listeners that an append has occurred. @@ -118,11 +113,8 @@ export class UnarchiveExtractEvent extends UnarchiveEvent { } /** * Base class for all Unarchivers. - * TODO: When EventTarget constructors are broadly supported, make this extend - * EventTarget and remove event listener code. - * https://caniuse.com/#feat=mdn-api_eventtarget_eventtarget */ -export class Unarchiver { +export class Unarchiver extends EventTarget { /** * @param {ArrayBuffer} arrayBuffer The Array Buffer. Note that this ArrayBuffer must not be * referenced once it is sent to the Unarchiver, since it is marked as Transferable and sent @@ -158,12 +150,6 @@ export class Unarchiver { * @type {boolean} */ debugMode_: boolean; - /** - * A map from event type to an array of listeners. - * @private - * @type {Map.} - */ - private listeners_; /** * Private web worker initialized during start(). * @private @@ -182,20 +168,6 @@ export class Unarchiver { * @protected. */ protected getScriptFileName(): string; - /** - * Adds an event listener for UnarchiveEvents. - * - * @param {string} Event type. - * @param {function} An event handler function. - */ - addEventListener(type: any, listener: any): void; - /** - * Removes an event listener. - * - * @param {string} Event type. - * @param {EventListener|function} An event listener or handler function. - */ - removeEventListener(type: any, listener: any): void; /** * Create an UnarchiveEvent out of the object sent back from the Worker. * @param {Object} obj diff --git a/types/archive/decompress-internal.d.ts.map b/types/archive/decompress-internal.d.ts.map index 9fed7cc..01c7ad3 100644 --- a/types/archive/decompress-internal.d.ts.map +++ b/types/archive/decompress-internal.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"decompress-internal.d.ts","sourceRoot":"","sources":["../../archive/decompress-internal.js"],"names":[],"mappings":"AAgbA;;;;;;;;GAQG;AACF,0CANU,WAAW,iCAEX,MAAO,MAAM,GAEX,UAAU,CAkBtB;;;;;;;;;;AAzaD;;GAEG;AACF;IACC;;OAEG;IACH,kBAFW,MAAM,EAQhB;IALC;;;OAGG;IACH,MAFU,MAAM,CAEA;CAEnB;AAED;;GAEG;AACF;IACC;;OAEG;IACH,sBAFW,MAAM,EAUhB;IALC;;;OAGG;IACH,UAFU,MAAM,CAEQ;CAE3B;AAED;;GAEG;AACH;IAOI;;;OAGG;IACH,KAFU,MAAM,CAEF;CAEjB;AAED;;GAEG;AACH;IAOI;;;OAGG;IACH,KAFU,MAAM,CAEF;CAEjB;AAED;;GAEG;AACH;IACE,cAEC;CACF;AAED;;GAEG;AACH;IACE;;OAEG;IACH,4BAGC;IADC,cAAwB;CAE3B;AAED;;GAEG;AACH;IACE;;;;;;;;OAQG;IACH,6BARW,MAAM,qBACN,MAAM,gCACN,MAAM,0BACN,MAAM,mCACN,MAAM,uBACN,MAAM,4BACN,MAAM,EAchB;IAPC,wBAAsC;IACtC,0BAA0C;IAC1C,qCAAgE;IAChE,4BAA8C;IAC9C,+BAAoD;IACpD,wCAAsE;IACtE,iCAAwD;CAE3D;AAED;;GAEG;AACH;IACE;;OAEG;IACH,4BAFW,cAAc,EASxB;IAJC;;OAEG;IACH,gBAFU,cAAc,CAEY;CAEvC;AAED;;;;;GAKG;AACF;IACC;;;;;;;;;;OAUG;IACH,yBAVW,WAAW,iCAIX,MAAO,MAAM,EAwDvB;IA3CC;;;;OAIG;IACH,cAHU,WAAW,CAGA;IAErB;;;;OAIG;IACH,wBAAqC;IAErC;;;;OAIG;IACH,qBAA8C;IAE9C;;;OAGG;IACH,YAFU,OAAO,CAEkB;IAEnC;;;;OAIG;IACH,mBAAoB;IAKpB;;;;OAIG;IACH,gBAAmB;IAGrB;;;;OAIG;IACH,yBAHa,MAAM,CAKlB;IAED;;;;OAIG;IACH,+BAHa,MAAM,CAKlB;IAED;;;;;OAKG;IACH,iDAMC;IAED;;;;;OAKG;IACH,oDAOC;IAED;;;;;OAKG;IACH,8BAsBC;IAED;;;;;OAKG;IACH,2BAYC;IAED;;OAEG;IACH,cA2BC;IAID;;;;;;;;OAQG;IACH,WAPW,WAAW,qBAGX,OAAO,oBAkBjB;IAED;;OAEG;IACH,aAIC;CACF;AAED;IACE,iEAEC;CAIF;AAED;IACE,iEAEC;CAIF;AAED;IACE,iEAEC;CAIF;;cA/Za,MAAM;cACN,UAAU"} \ No newline at end of file +{"version":3,"file":"decompress-internal.d.ts","sourceRoot":"","sources":["../../archive/decompress-internal.js"],"names":[],"mappings":"AAiYA;;;;;;;;GAQG;AACF,0CANU,WAAW,iCAEX,MAAO,MAAM,GAEX,UAAU,CAkBtB;;;;;;;;;;AA1XD;;GAEG;AACF;IACC;;OAEG;IACH,kBAFW,MAAM,EAIhB;CACF;AAED;;GAEG;AACF;IACC;;OAEG;IACH,sBAFW,MAAM,EAUhB;IALC;;;OAGG;IACH,UAFU,MAAM,CAEQ;CAE3B;AAED;;GAEG;AACH;IAOI;;;OAGG;IACH,KAFU,MAAM,CAEF;CAEjB;AAED;;GAEG;AACH;IAOI;;;OAGG;IACH,KAFU,MAAM,CAEF;CAEjB;AAED;;GAEG;AACH;IACE,cAEC;CACF;AAED;;GAEG;AACH;IACE;;OAEG;IACH,4BAGC;IADC,cAAwB;CAE3B;AAED;;GAEG;AACH;IACE;;;;;;;;OAQG;IACH,6BARW,MAAM,qBACN,MAAM,gCACN,MAAM,0BACN,MAAM,mCACN,MAAM,uBACN,MAAM,4BACN,MAAM,EAchB;IAPC,wBAAsC;IACtC,0BAA0C;IAC1C,qCAAgE;IAChE,4BAA8C;IAC9C,+BAAoD;IACpD,wCAAsE;IACtE,iCAAwD;CAE3D;AAED;;GAEG;AACH;IACE;;OAEG;IACH,4BAFW,cAAc,EASxB;IAJC;;OAEG;IACH,gBAFU,cAAc,CAEY;CAEvC;AAED;;GAEG;AACF;IACC;;;;;;;;;;OAUG;IACH,yBAVW,WAAW,iCAIX,MAAO,MAAM,EAgDvB;IAjCC;;;;OAIG;IACH,cAHU,WAAW,CAGA;IAErB;;;;OAIG;IACH,wBAAqC;IAErC;;;;OAIG;IACH,qBAA8C;IAE9C;;;OAGG;IACH,YAFU,OAAO,CAEkB;IAEnC;;;;OAIG;IACH,gBAAmB;IAGrB;;;;OAIG;IACH,yBAHa,MAAM,CAKlB;IAED;;;;OAIG;IACH,+BAHa,MAAM,CAKlB;IAED;;;;;OAKG;IACH,8BAsBC;IAED;;;;;OAKG;IACH,2BAWC;IAED;;OAEG;IACH,cA2BC;IAID;;;;;;;;OAQG;IACH,WAPW,WAAW,qBAGX,OAAO,oBAgBjB;IAED;;OAEG;IACH,aAIC;CACF;AAED;IACE,iEAEC;CAIF;AAED;IACE,iEAEC;CAIF;AAED;IACE,iEAEC;CAIF;;cAhXa,MAAM;cACN,UAAU"} \ No newline at end of file diff --git a/types/codecs/codecs.d.ts b/types/codecs/codecs.d.ts index df42b8b..bcddced 100644 --- a/types/codecs/codecs.d.ts +++ b/types/codecs/codecs.d.ts @@ -17,7 +17,8 @@ * @property {string} r_frame_rate Like "60000/1001" */ /** - * @typedef ProbeFormat ffprobe -show_format -print_format json. Only the fields we care about. + * @typedef ProbeFormat Only the fields we care about from the following command: + * ffprobe -show_format -show_streams -v quiet -print_format json -i file.mp4 * @property {string} filename * @property {string} format_name * @property {string} duration Number of seconds, as a string like "473.506367". @@ -69,7 +70,8 @@ export type ProbeStream = { r_frame_rate: string; }; /** - * ffprobe -show_format -print_format json. Only the fields we care about. + * Only the fields we care about from the following command: + * ffprobe -show_format -show_streams -v quiet -print_format json -i file.mp4 */ export type ProbeFormat = { filename: string; diff --git a/types/codecs/codecs.d.ts.map b/types/codecs/codecs.d.ts.map index 3dc01dc..cb57957 100644 --- a/types/codecs/codecs.d.ts.map +++ b/types/codecs/codecs.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"codecs.d.ts","sourceRoot":"","sources":["../../codecs/codecs.js"],"names":[],"mappings":"AAQA;;;GAGG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;;;;;GAOG;AAEH;;;;GAIG;AAEH;;;;GAIG;AACH,yCAHW,SAAS,GACP,MAAM,CAuClB;AAED;;;;;;;;;GASG;AACH,wCAHW,SAAS,GACP,MAAM,CAyBlB;;;;;WAzGa,MAAM;gBACN,MAAM;qBACN,MAAM;aACN,MAAM;;;;gBACN,MAAM;sBACN,MAAM;QACN,MAAM;WACN,MAAM;WACN,MAAM;YACN,MAAM;;;;kBACN,MAAM;;;;;;cAKN,MAAM;iBACN,MAAM;;;;cACN,MAAM;;;;UACN,MAAM;;;;cACN,MAAM;;;;;;aAKN,WAAW,EAAE;YACb,WAAW"} \ No newline at end of file +{"version":3,"file":"codecs.d.ts","sourceRoot":"","sources":["../../codecs/codecs.js"],"names":[],"mappings":"AAQA;;;GAGG;AAEH;;;;;;;;;;;;;GAaG;AAEH;;;;;;;;GAQG;AAEH;;;;GAIG;AAEH;;;;GAIG;AACH,yCAHW,SAAS,GACP,MAAM,CAgDlB;AAED;;;;;;;;;GASG;AACH,wCAHW,SAAS,GACP,MAAM,CA0DlB;;;;;WApJa,MAAM;gBACN,MAAM;qBACN,MAAM;aACN,MAAM;;;;gBACN,MAAM;sBACN,MAAM;QACN,MAAM;WACN,MAAM;WACN,MAAM;YACN,MAAM;;;;kBACN,MAAM;;;;;;;cAMN,MAAM;iBACN,MAAM;;;;cACN,MAAM;;;;UACN,MAAM;;;;cACN,MAAM;;;;;;aAKN,WAAW,EAAE;YACb,WAAW"} \ No newline at end of file diff --git a/types/file/sniffer.d.ts.map b/types/file/sniffer.d.ts.map index 9b08e38..5c7afc8 100644 --- a/types/file/sniffer.d.ts.map +++ b/types/file/sniffer.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"sniffer.d.ts","sourceRoot":"","sources":["../../file/sniffer.js"],"names":[],"mappings":"AA+DA;;;GAGG;AACH,mCAiCC;AAED;;;;GAIG;AACH,iCAHW,WAAW,GACT,MAAM,CAqBlB"} \ No newline at end of file +{"version":3,"file":"sniffer.d.ts","sourceRoot":"","sources":["../../file/sniffer.js"],"names":[],"mappings":"AAuFA;;;GAGG;AACH,mCAqCC;AAED;;;;GAIG;AACH,iCAHW,WAAW,GACT,MAAM,CAoBlB"} \ No newline at end of file diff --git a/types/io/bitstream.d.ts b/types/io/bitstream.d.ts index 79fc223..92186ae 100644 --- a/types/io/bitstream.d.ts +++ b/types/io/bitstream.d.ts @@ -27,10 +27,12 @@ export const BitStream: { peekBits: (n: number, opt_movePointers: any) => number; /** * Returns how many bites have been read in the stream since the beginning of time. + * @returns {number} */ getNumBitsRead(): number; /** * Returns how many bits are currently in the stream left to be read. + * @returns {number} */ getNumBitsLeft(): number; /** @@ -60,6 +62,7 @@ export const BitStream: { * Bit at (bytePtr,bitPtr) has the highest position in returning data. * Taken from getbits.hpp in unrar. * TODO: Move this out of BitStream and into unrar. + * @returns {number} */ getBits(): number; /** diff --git a/types/io/bitstream.d.ts.map b/types/io/bitstream.d.ts.map index b81ff4a..4570782 100644 --- a/types/io/bitstream.d.ts.map +++ b/types/io/bitstream.d.ts.map @@ -1 +1 @@ -{"version":3,"file":"bitstream.d.ts","sourceRoot":"","sources":["../../io/bitstream.js"],"names":[],"mappings":"AACA;aAwBe,WAAW,OACX,OAAO;QAchB;;;;WAIG;eAFO,UAAU;QAKpB;;;;WAIG;;QAGH;;;;WAIG;;QAGH;;;;WAIG;;sBAqFM,MAAM,4BAEJ,MAAM;QAjFnB;;WAEG;;QAKH;;WAEG;;QAMH;;;;;;;;;WASG;wBAHQ,MAAM,0BAEJ,MAAM;QAkDnB;;;;;;;;;WASG;wBAHQ,MAAM,0BAEJ,MAAM;QAgDnB;;;;;WAKG;;QAOH;;;;WAIG;oBAFQ,MAAM,GACJ,MAAM;QAMnB;;;;;;;WAOG;qBAHQ,MAAM,0BAEJ,UAAU;QAmDvB;;;WAGG;qBAFQ,MAAM,GACJ,UAAU;;EAQtB"} \ No newline at end of file +{"version":3,"file":"bitstream.d.ts","sourceRoot":"","sources":["../../io/bitstream.js"],"names":[],"mappings":"AACA;aA8Ce,WAAW,OACX,OAAO;QAchB;;;;WAIG;eAFO,UAAU;QAKpB;;;;WAIG;;QAGH;;;;WAIG;;QAGH;;;;WAIG;;sBAuFM,MAAM,4BAEJ,MAAM;QAnFnB;;;WAGG;0BADU,MAAM;QAMnB;;;WAGG;0BADU,MAAM;QAOnB;;;;;;;;;WASG;wBAHQ,MAAM,0BAEJ,MAAM;QAkDnB;;;;;;;;;WASG;wBAHQ,MAAM,0BAEJ,MAAM;QAgDnB;;;;;;WAMG;mBADU,MAAM;QAQnB;;;;WAIG;oBAFQ,MAAM,GACJ,MAAM;QAMnB;;;;;;;WAOG;qBAHQ,MAAM,0BAEJ,UAAU;QAmDvB;;;WAGG;qBAFQ,MAAM,GACJ,UAAU;;EAQtB"} \ No newline at end of file