@pixi/prepare - npm Package Compare versions

Comparing version 6.1.3 to 6.2.0

dist/browser/prepare.js

 /*!
- * @pixi/prepare - v6.1.3
- * Compiled Mon, 13 Sep 2021 15:29:31 UTC
+ * @pixi/prepare - v6.2.0
+ * Compiled Mon, 01 Nov 2021 16:52:10 UTC
  *
@@ -218,3 +218,2 @@ * @pixi/prepare is licensed under the MIT License.
      *
-     * @class
      * @memberof PIXI
@@ -224,21 +223,9 @@ */
         /**
-         * @param {number} maxItemsPerFrame - The maximum number of items that can be prepared each frame.
+         * @param maxItemsPerFrame - The maximum number of items that can be prepared each frame.
          */
         function CountLimiter(maxItemsPerFrame) {
-            /**
-             * The maximum number of items that can be prepared each frame.
-             * @type {number}
-             * @private
-             */
             this.maxItemsPerFrame = maxItemsPerFrame;
-            /**
-             * The number of items that can be prepared in the current frame.
-             * @type {number}
-             * @private
-             */
             this.itemsLeft = 0;
         }
-        /**
-         * Resets any counting properties to start fresh on a new frame.
-         */
+        /** Resets any counting properties to start fresh on a new frame. */
         CountLimiter.prototype.beginFrame = function () {
@@ -249,3 +236,4 @@ this.itemsLeft = this.maxItemsPerFrame;
          * Checks to see if another item can be uploaded. This should only be called once per item.
-         * @return {boolean} If the item is allowed to be uploaded.
+         *
+         * @return If the item is allowed to be uploaded.
          */
@@ -262,5 +250,5 @@ CountLimiter.prototype.allowedToUpload = function () {
      * @private
-     * @param {PIXI.DisplayObject} item - Display object to check
-     * @param {Array<*>} queue - Collection of items to upload
-     * @return {boolean} if a PIXI.Texture object was found.
+     * @param item - Display object to check
+     * @param queue - Collection of items to upload
+     * @return If a PIXI.Texture object was found.
      */
@@ -287,5 +275,5 @@ function findMultipleBaseTextures(item, queue) {
      * @private
-     * @param {PIXI.Texture} item - Display object to check
-     * @param {Array<*>} queue - Collection of items to upload
-     * @return {boolean} if a PIXI.Texture object was found.
+     * @param item - Display object to check
+     * @param queue - Collection of items to upload
+     * @return If a PIXI.Texture object was found.
      */
@@ -306,5 +294,5 @@ function findBaseTexture(item, queue) {
      * @private
-     * @param {PIXI.DisplayObject} item - Display object to check
-     * @param {Array<*>} queue - Collection of items to upload
-     * @return {boolean} if a PIXI.Texture object was found.
+     * @param item - Display object to check
+     * @param queue - Collection of items to upload
+     * @return If a PIXI.Texture object was found.
      */
@@ -325,5 +313,5 @@ function findTexture(item, queue) {
      * @private
-     * @param {PIXI.AbstractRenderer|PIXI.BasePrepare} helper - Not used by this upload handler
-     * @param {PIXI.DisplayObject} item - Item to check
-     * @return {boolean} If item was uploaded.
+     * @param helper - Not used by this upload handler
+     * @param item - Item to check
+     * @return If item was uploaded.
      */
@@ -342,5 +330,5 @@ function drawText(_helper, item) {
      * @private
-     * @param {PIXI.AbstractRenderer|PIXI.BasePrepare} helper - Not used by this upload handler
-     * @param {PIXI.DisplayObject} item - Item to check
-     * @return {boolean} If item was uploaded.
+     * @param helper - Not used by this upload handler
+     * @param item - Item to check
+     * @return If item was uploaded.
      */
@@ -359,5 +347,5 @@ function calculateTextStyle(_helper, item) {
      * @private
-     * @param {PIXI.DisplayObject} item - Display object to check
-     * @param {Array<*>} queue - Collection of items to upload
-     * @return {boolean} if a PIXI.Text object was found.
+     * @param item - Display object to check
+     * @param queue - Collection of items to upload
+     * @return if a PIXI.Text object was found.
      */
@@ -387,5 +375,5 @@ function findText(item, queue) {
      * @private
-     * @param {PIXI.TextStyle} item - Display object to check
-     * @param {Array<*>} queue - Collection of items to upload
-     * @return {boolean} if a PIXI.TextStyle object was found.
+     * @param item - Display object to check
+     * @param queue - Collection of items to upload
+     * @return If a PIXI.TextStyle object was found.
      */
@@ -421,3 +409,2 @@ function findTextStyle(item, queue) {
      * @abstract
-     * @class
      * @memberof PIXI
@@ -431,55 +418,10 @@ */
             var _this = this;
-            /**
-             * The limiter to be used to control how quickly items are prepared.
-             * @type {PIXI.CountLimiter|PIXI.TimeLimiter}
-             */
             this.limiter = new CountLimiter(settings.settings.UPLOADS_PER_FRAME);
-            /**
-             * Reference to the renderer.
-             * @type {PIXI.AbstractRenderer}
-             * @protected
-             */
             this.renderer = renderer;
-            /**
-             * The only real difference between CanvasPrepare and Prepare is what they pass
-             * to upload hooks. That different parameter is stored here.
-             * @type {object}
-             * @protected
-             */
             this.uploadHookHelper = null;
-            /**
-             * Collection of items to uploads at once.
-             * @type {Array<*>}
-             * @private
-             */
             this.queue = [];
-            /**
-             * Collection of additional hooks for finding assets.
-             * @type {Array<Function>}
-             * @private
-             */
             this.addHooks = [];
-            /**
-             * Collection of additional hooks for processing assets.
-             * @type {Array<Function>}
-             * @private
-             */
             this.uploadHooks = [];
-            /**
-             * Callback to call after completed.
-             * @type {Array<Function>}
-             * @private
-             */
             this.completes = [];
-            /**
-             * If prepare is ticking (running).
-             * @type {boolean}
-             * @private
-             */
             this.ticking = false;
-            /**
-             * 'bound' call for prepareItems().
-             * @type {Function}
-             * @private
-             */
             this.delayedTick = function () {
@@ -586,3 +528,3 @@ // unlikely, but in case we were destroyed between tick() and delayedTick()
          *          function must return `true` if it was able to add item to the queue.
-         * @return {this} Instance of plugin for chaining.
+         * @return Instance of plugin for chaining.
          */
@@ -600,3 +542,3 @@ BasePrepare.prototype.registerFindHook = function (addHook) {
          *          function must return `true` if it was able to handle upload of item.
-         * @return {this} Instance of plugin for chaining.
+         * @return Instance of plugin for chaining.
          */
@@ -614,3 +556,3 @@ BasePrepare.prototype.registerUploadHook = function (uploadHook) {
          *        add to the queue
-         * @return {this} Instance of plugin for chaining.
+         * @return Instance of plugin for chaining.
          */
@@ -633,6 +575,3 @@ BasePrepare.prototype.add = function (item) {
         };
-        /**
-         * Destroys the plugin, don't use after this.
-         *
-         */
+        /** Destroys the plugin, don't use after this. */
         BasePrepare.prototype.destroy = function () {
@@ -658,5 +597,5 @@ if (this.ticking) {
      * @private
-     * @param {PIXI.Renderer} renderer - instance of the webgl renderer
-     * @param {PIXI.BaseTexture} item - Item to check
-     * @return {boolean} If item was uploaded.
+     * @param renderer - instance of the webgl renderer
+     * @param item - Item to check
+     * @return If item was uploaded.
      */
@@ -679,5 +618,5 @@ function uploadBaseTextures(renderer, item) {
      * @private
-     * @param {PIXI.Renderer} renderer - instance of the webgl renderer
-     * @param {PIXI.DisplayObject} item - Item to check
-     * @return {boolean} If item was uploaded.
+     * @param renderer - instance of the webgl renderer
+     * @param item - Item to check
+     * @return If item was uploaded.
      */
@@ -710,5 +649,5 @@ function uploadGraphics(renderer, item) {
      * @private
-     * @param {PIXI.DisplayObject} item - Display object to check
-     * @param {Array<*>} queue - Collection of items to upload
-     * @return {boolean} if a PIXI.Graphics object was found.
+     * @param item - Display object to check
+     * @param queue - Collection of items to upload
+     * @return if a PIXI.Graphics object was found.
      */
@@ -749,4 +688,3 @@ function findGraphics(item, queue) {
      *
-     * @class
-     * @extends PIXI.BasePrepare
+     *
      * @memberof PIXI
@@ -753,0 +691,0 @@ */

dist/browser/prepare.min.js

 /*!
- * @pixi/prepare - v6.1.3
- * Compiled Mon, 13 Sep 2021 15:29:31 UTC
+ * @pixi/prepare - v6.2.0
+ * Compiled Mon, 01 Nov 2021 16:52:10 UTC
  *
@@ -5,0 +5,0 @@ * @pixi/prepare is licensed under the MIT License.

dist/cjs/prepare.js

 /*!
- * @pixi/prepare - v6.1.3
- * Compiled Mon, 13 Sep 2021 15:29:31 UTC
+ * @pixi/prepare - v6.2.0
+ * Compiled Mon, 01 Nov 2021 16:52:10 UTC
  *
@@ -63,3 +63,2 @@ * @pixi/prepare is licensed under the MIT License.
  *
- * @class
  * @memberof PIXI
@@ -69,21 +68,9 @@ */
     /**
-     * @param {number} maxItemsPerFrame - The maximum number of items that can be prepared each frame.
+     * @param maxItemsPerFrame - The maximum number of items that can be prepared each frame.
      */
     function CountLimiter(maxItemsPerFrame) {
-        /**
-         * The maximum number of items that can be prepared each frame.
-         * @type {number}
-         * @private
-         */
         this.maxItemsPerFrame = maxItemsPerFrame;
-        /**
-         * The number of items that can be prepared in the current frame.
-         * @type {number}
-         * @private
-         */
         this.itemsLeft = 0;
     }
-    /**
-     * Resets any counting properties to start fresh on a new frame.
-     */
+    /** Resets any counting properties to start fresh on a new frame. */
     CountLimiter.prototype.beginFrame = function () {
@@ -94,3 +81,4 @@ this.itemsLeft = this.maxItemsPerFrame;
      * Checks to see if another item can be uploaded. This should only be called once per item.
-     * @return {boolean} If the item is allowed to be uploaded.
+     *
+     * @return If the item is allowed to be uploaded.
      */
@@ -107,5 +95,5 @@ CountLimiter.prototype.allowedToUpload = function () {
  * @private
- * @param {PIXI.DisplayObject} item - Display object to check
- * @param {Array<*>} queue - Collection of items to upload
- * @return {boolean} if a PIXI.Texture object was found.
+ * @param item - Display object to check
+ * @param queue - Collection of items to upload
+ * @return If a PIXI.Texture object was found.
  */
@@ -132,5 +120,5 @@ function findMultipleBaseTextures(item, queue) {
  * @private
- * @param {PIXI.Texture} item - Display object to check
- * @param {Array<*>} queue - Collection of items to upload
- * @return {boolean} if a PIXI.Texture object was found.
+ * @param item - Display object to check
+ * @param queue - Collection of items to upload
+ * @return If a PIXI.Texture object was found.
  */
@@ -151,5 +139,5 @@ function findBaseTexture(item, queue) {
  * @private
- * @param {PIXI.DisplayObject} item - Display object to check
- * @param {Array<*>} queue - Collection of items to upload
- * @return {boolean} if a PIXI.Texture object was found.
+ * @param item - Display object to check
+ * @param queue - Collection of items to upload
+ * @return If a PIXI.Texture object was found.
  */
@@ -170,5 +158,5 @@ function findTexture(item, queue) {
  * @private
- * @param {PIXI.AbstractRenderer|PIXI.BasePrepare} helper - Not used by this upload handler
- * @param {PIXI.DisplayObject} item - Item to check
- * @return {boolean} If item was uploaded.
+ * @param helper - Not used by this upload handler
+ * @param item - Item to check
+ * @return If item was uploaded.
  */
@@ -187,5 +175,5 @@ function drawText(_helper, item) {
  * @private
- * @param {PIXI.AbstractRenderer|PIXI.BasePrepare} helper - Not used by this upload handler
- * @param {PIXI.DisplayObject} item - Item to check
- * @return {boolean} If item was uploaded.
+ * @param helper - Not used by this upload handler
+ * @param item - Item to check
+ * @return If item was uploaded.
  */
@@ -204,5 +192,5 @@ function calculateTextStyle(_helper, item) {
  * @private
- * @param {PIXI.DisplayObject} item - Display object to check
- * @param {Array<*>} queue - Collection of items to upload
- * @return {boolean} if a PIXI.Text object was found.
+ * @param item - Display object to check
+ * @param queue - Collection of items to upload
+ * @return if a PIXI.Text object was found.
  */
@@ -232,5 +220,5 @@ function findText(item, queue) {
  * @private
- * @param {PIXI.TextStyle} item - Display object to check
- * @param {Array<*>} queue - Collection of items to upload
- * @return {boolean} if a PIXI.TextStyle object was found.
+ * @param item - Display object to check
+ * @param queue - Collection of items to upload
+ * @return If a PIXI.TextStyle object was found.
  */
@@ -266,3 +254,2 @@ function findTextStyle(item, queue) {
  * @abstract
- * @class
  * @memberof PIXI
@@ -276,55 +263,10 @@ */
         var _this = this;
-        /**
-         * The limiter to be used to control how quickly items are prepared.
-         * @type {PIXI.CountLimiter|PIXI.TimeLimiter}
-         */
         this.limiter = new CountLimiter(settings.settings.UPLOADS_PER_FRAME);
-        /**
-         * Reference to the renderer.
-         * @type {PIXI.AbstractRenderer}
-         * @protected
-         */
         this.renderer = renderer;
-        /**
-         * The only real difference between CanvasPrepare and Prepare is what they pass
-         * to upload hooks. That different parameter is stored here.
-         * @type {object}
-         * @protected
-         */
         this.uploadHookHelper = null;
-        /**
-         * Collection of items to uploads at once.
-         * @type {Array<*>}
-         * @private
-         */
         this.queue = [];
-        /**
-         * Collection of additional hooks for finding assets.
-         * @type {Array<Function>}
-         * @private
-         */
         this.addHooks = [];
-        /**
-         * Collection of additional hooks for processing assets.
-         * @type {Array<Function>}
-         * @private
-         */
         this.uploadHooks = [];
-        /**
-         * Callback to call after completed.
-         * @type {Array<Function>}
-         * @private
-         */
         this.completes = [];
-        /**
-         * If prepare is ticking (running).
-         * @type {boolean}
-         * @private
-         */
         this.ticking = false;
-        /**
-         * 'bound' call for prepareItems().
-         * @type {Function}
-         * @private
-         */
         this.delayedTick = function () {
@@ -431,3 +373,3 @@ // unlikely, but in case we were destroyed between tick() and delayedTick()
      *          function must return `true` if it was able to add item to the queue.
-     * @return {this} Instance of plugin for chaining.
+     * @return Instance of plugin for chaining.
      */
@@ -445,3 +387,3 @@ BasePrepare.prototype.registerFindHook = function (addHook) {
      *          function must return `true` if it was able to handle upload of item.
-     * @return {this} Instance of plugin for chaining.
+     * @return Instance of plugin for chaining.
      */
@@ -459,3 +401,3 @@ BasePrepare.prototype.registerUploadHook = function (uploadHook) {
      *        add to the queue
-     * @return {this} Instance of plugin for chaining.
+     * @return Instance of plugin for chaining.
      */
@@ -478,6 +420,3 @@ BasePrepare.prototype.add = function (item) {
     };
-    /**
-     * Destroys the plugin, don't use after this.
-     *
-     */
+    /** Destroys the plugin, don't use after this. */
     BasePrepare.prototype.destroy = function () {
@@ -503,5 +442,5 @@ if (this.ticking) {
  * @private
- * @param {PIXI.Renderer} renderer - instance of the webgl renderer
- * @param {PIXI.BaseTexture} item - Item to check
- * @return {boolean} If item was uploaded.
+ * @param renderer - instance of the webgl renderer
+ * @param item - Item to check
+ * @return If item was uploaded.
  */
@@ -524,5 +463,5 @@ function uploadBaseTextures(renderer, item) {
  * @private
- * @param {PIXI.Renderer} renderer - instance of the webgl renderer
- * @param {PIXI.DisplayObject} item - Item to check
- * @return {boolean} If item was uploaded.
+ * @param renderer - instance of the webgl renderer
+ * @param item - Item to check
+ * @return If item was uploaded.
  */
@@ -555,5 +494,5 @@ function uploadGraphics(renderer, item) {
  * @private
- * @param {PIXI.DisplayObject} item - Display object to check
- * @param {Array<*>} queue - Collection of items to upload
- * @return {boolean} if a PIXI.Graphics object was found.
+ * @param item - Display object to check
+ * @param queue - Collection of items to upload
+ * @return if a PIXI.Graphics object was found.
  */
@@ -594,4 +533,3 @@ function findGraphics(item, queue) {
  *
- * @class
- * @extends PIXI.BasePrepare
+ *
  * @memberof PIXI
@@ -598,0 +536,0 @@ */

dist/cjs/prepare.min.js

 /*!
- * @pixi/prepare - v6.1.3
- * Compiled Mon, 13 Sep 2021 15:29:31 UTC
+ * @pixi/prepare - v6.2.0
+ * Compiled Mon, 01 Nov 2021 16:52:10 UTC
  *
@@ -5,0 +5,0 @@ * @pixi/prepare is licensed under the MIT License.

dist/esm/prepare.js

 /*!
- * @pixi/prepare - v6.1.3
- * Compiled Mon, 13 Sep 2021 15:29:31 UTC
+ * @pixi/prepare - v6.2.0
+ * Compiled Mon, 01 Nov 2021 16:52:10 UTC
  *
@@ -59,3 +59,2 @@ * @pixi/prepare is licensed under the MIT License.
  *
- * @class
  * @memberof PIXI
@@ -65,21 +64,9 @@ */
     /**
-     * @param {number} maxItemsPerFrame - The maximum number of items that can be prepared each frame.
+     * @param maxItemsPerFrame - The maximum number of items that can be prepared each frame.
      */
     function CountLimiter(maxItemsPerFrame) {
-        /**
-         * The maximum number of items that can be prepared each frame.
-         * @type {number}
-         * @private
-         */
         this.maxItemsPerFrame = maxItemsPerFrame;
-        /**
-         * The number of items that can be prepared in the current frame.
-         * @type {number}
-         * @private
-         */
         this.itemsLeft = 0;
     }
-    /**
-     * Resets any counting properties to start fresh on a new frame.
-     */
+    /** Resets any counting properties to start fresh on a new frame. */
     CountLimiter.prototype.beginFrame = function () {
@@ -90,3 +77,4 @@ this.itemsLeft = this.maxItemsPerFrame;
      * Checks to see if another item can be uploaded. This should only be called once per item.
-     * @return {boolean} If the item is allowed to be uploaded.
+     *
+     * @return If the item is allowed to be uploaded.
      */
@@ -103,5 +91,5 @@ CountLimiter.prototype.allowedToUpload = function () {
  * @private
- * @param {PIXI.DisplayObject} item - Display object to check
- * @param {Array<*>} queue - Collection of items to upload
- * @return {boolean} if a PIXI.Texture object was found.
+ * @param item - Display object to check
+ * @param queue - Collection of items to upload
+ * @return If a PIXI.Texture object was found.
  */
@@ -128,5 +116,5 @@ function findMultipleBaseTextures(item, queue) {
  * @private
- * @param {PIXI.Texture} item - Display object to check
- * @param {Array<*>} queue - Collection of items to upload
- * @return {boolean} if a PIXI.Texture object was found.
+ * @param item - Display object to check
+ * @param queue - Collection of items to upload
+ * @return If a PIXI.Texture object was found.
  */
@@ -147,5 +135,5 @@ function findBaseTexture(item, queue) {
  * @private
- * @param {PIXI.DisplayObject} item - Display object to check
- * @param {Array<*>} queue - Collection of items to upload
- * @return {boolean} if a PIXI.Texture object was found.
+ * @param item - Display object to check
+ * @param queue - Collection of items to upload
+ * @return If a PIXI.Texture object was found.
  */
@@ -166,5 +154,5 @@ function findTexture(item, queue) {
  * @private
- * @param {PIXI.AbstractRenderer|PIXI.BasePrepare} helper - Not used by this upload handler
- * @param {PIXI.DisplayObject} item - Item to check
- * @return {boolean} If item was uploaded.
+ * @param helper - Not used by this upload handler
+ * @param item - Item to check
+ * @return If item was uploaded.
  */
@@ -183,5 +171,5 @@ function drawText(_helper, item) {
  * @private
- * @param {PIXI.AbstractRenderer|PIXI.BasePrepare} helper - Not used by this upload handler
- * @param {PIXI.DisplayObject} item - Item to check
- * @return {boolean} If item was uploaded.
+ * @param helper - Not used by this upload handler
+ * @param item - Item to check
+ * @return If item was uploaded.
  */
@@ -200,5 +188,5 @@ function calculateTextStyle(_helper, item) {
  * @private
- * @param {PIXI.DisplayObject} item - Display object to check
- * @param {Array<*>} queue - Collection of items to upload
- * @return {boolean} if a PIXI.Text object was found.
+ * @param item - Display object to check
+ * @param queue - Collection of items to upload
+ * @return if a PIXI.Text object was found.
  */
@@ -228,5 +216,5 @@ function findText(item, queue) {
  * @private
- * @param {PIXI.TextStyle} item - Display object to check
- * @param {Array<*>} queue - Collection of items to upload
- * @return {boolean} if a PIXI.TextStyle object was found.
+ * @param item - Display object to check
+ * @param queue - Collection of items to upload
+ * @return If a PIXI.TextStyle object was found.
  */
@@ -262,3 +250,2 @@ function findTextStyle(item, queue) {
  * @abstract
- * @class
  * @memberof PIXI
@@ -272,55 +259,10 @@ */
         var _this = this;
-        /**
-         * The limiter to be used to control how quickly items are prepared.
-         * @type {PIXI.CountLimiter|PIXI.TimeLimiter}
-         */
         this.limiter = new CountLimiter(settings.UPLOADS_PER_FRAME);
-        /**
-         * Reference to the renderer.
-         * @type {PIXI.AbstractRenderer}
-         * @protected
-         */
         this.renderer = renderer;
-        /**
-         * The only real difference between CanvasPrepare and Prepare is what they pass
-         * to upload hooks. That different parameter is stored here.
-         * @type {object}
-         * @protected
-         */
         this.uploadHookHelper = null;
-        /**
-         * Collection of items to uploads at once.
-         * @type {Array<*>}
-         * @private
-         */
         this.queue = [];
-        /**
-         * Collection of additional hooks for finding assets.
-         * @type {Array<Function>}
-         * @private
-         */
         this.addHooks = [];
-        /**
-         * Collection of additional hooks for processing assets.
-         * @type {Array<Function>}
-         * @private
-         */
         this.uploadHooks = [];
-        /**
-         * Callback to call after completed.
-         * @type {Array<Function>}
-         * @private
-         */
         this.completes = [];
-        /**
-         * If prepare is ticking (running).
-         * @type {boolean}
-         * @private
-         */
         this.ticking = false;
-        /**
-         * 'bound' call for prepareItems().
-         * @type {Function}
-         * @private
-         */
         this.delayedTick = function () {
@@ -427,3 +369,3 @@ // unlikely, but in case we were destroyed between tick() and delayedTick()
      *          function must return `true` if it was able to add item to the queue.
-     * @return {this} Instance of plugin for chaining.
+     * @return Instance of plugin for chaining.
      */
@@ -441,3 +383,3 @@ BasePrepare.prototype.registerFindHook = function (addHook) {
      *          function must return `true` if it was able to handle upload of item.
-     * @return {this} Instance of plugin for chaining.
+     * @return Instance of plugin for chaining.
      */
@@ -455,3 +397,3 @@ BasePrepare.prototype.registerUploadHook = function (uploadHook) {
      *        add to the queue
-     * @return {this} Instance of plugin for chaining.
+     * @return Instance of plugin for chaining.
      */
@@ -474,6 +416,3 @@ BasePrepare.prototype.add = function (item) {
     };
-    /**
-     * Destroys the plugin, don't use after this.
-     *
-     */
+    /** Destroys the plugin, don't use after this. */
     BasePrepare.prototype.destroy = function () {
@@ -499,5 +438,5 @@ if (this.ticking) {
  * @private
- * @param {PIXI.Renderer} renderer - instance of the webgl renderer
- * @param {PIXI.BaseTexture} item - Item to check
- * @return {boolean} If item was uploaded.
+ * @param renderer - instance of the webgl renderer
+ * @param item - Item to check
+ * @return If item was uploaded.
  */
@@ -520,5 +459,5 @@ function uploadBaseTextures(renderer, item) {
  * @private
- * @param {PIXI.Renderer} renderer - instance of the webgl renderer
- * @param {PIXI.DisplayObject} item - Item to check
- * @return {boolean} If item was uploaded.
+ * @param renderer - instance of the webgl renderer
+ * @param item - Item to check
+ * @return If item was uploaded.
  */
@@ -551,5 +490,5 @@ function uploadGraphics(renderer, item) {
  * @private
- * @param {PIXI.DisplayObject} item - Display object to check
- * @param {Array<*>} queue - Collection of items to upload
- * @return {boolean} if a PIXI.Graphics object was found.
+ * @param item - Display object to check
+ * @param queue - Collection of items to upload
+ * @return if a PIXI.Graphics object was found.
  */
@@ -590,4 +529,3 @@ function findGraphics(item, queue) {
  *
- * @class
- * @extends PIXI.BasePrepare
+ *
  * @memberof PIXI
@@ -594,0 +532,0 @@ */

dist/esm/prepare.min.js

 /*!
- * @pixi/prepare - v6.1.3
- * Compiled Mon, 13 Sep 2021 15:29:31 UTC
+ * @pixi/prepare - v6.2.0
+ * Compiled Mon, 01 Nov 2021 16:52:10 UTC
  *
@@ -5,0 +5,0 @@ * @pixi/prepare is licensed under the MIT License.

index.d.ts

@@ -27,14 +27,43 @@ import type { AbstractRenderer } from '@pixi/core';
  * @abstract
- * @class
  * @memberof PIXI
  */
 export declare class BasePrepare {
+    /**
+     * The limiter to be used to control how quickly items are prepared.
+     * @type {PIXI.CountLimiter|PIXI.TimeLimiter}
+     */
     private limiter;
+    /** Reference to the renderer. */
     protected renderer: AbstractRenderer;
+    /**
+     * The only real difference between CanvasPrepare and Prepare is what they pass
+     * to upload hooks. That different parameter is stored here.
+     */
     protected uploadHookHelper: any;
+    /** Collection of items to uploads at once. */
     protected queue: Array<any>;
+    /**
+     * Collection of additional hooks for finding assets.
+     * @type {Array<Function>}
+     */
     addHooks: Array<any>;
+    /**
+     * Collection of additional hooks for processing assets.
+     * @type {Array<Function>}
+     */
     uploadHooks: Array<any>;
+    /**
+     * Callback to call after completed.
+     * @type {Array<Function>}
+     */
     completes: Array<any>;
+    /**
+     * If prepare is ticking (running).
+     * @type {boolean}
+     */
     ticking: boolean;
+    /**
+     * 'bound' call for prepareItems().
+     * @type {Function}
+     */
     private delayedTick;
@@ -72,3 +101,3 @@ /**
      *          function must return `true` if it was able to add item to the queue.
-     * @return {this} Instance of plugin for chaining.
+     * @return Instance of plugin for chaining.
      */
@@ -81,3 +110,3 @@ registerFindHook(addHook: IFindHook): this;
      *          function must return `true` if it was able to handle upload of item.
-     * @return {this} Instance of plugin for chaining.
+     * @return Instance of plugin for chaining.
      */
@@ -90,9 +119,6 @@ registerUploadHook(uploadHook: IUploadHook): this;
      *        add to the queue
-     * @return {this} Instance of plugin for chaining.
+     * @return Instance of plugin for chaining.
      */
     add(item: IDisplayObjectExtended | IUploadHook | IFindHook): this;
-    /**
-     * Destroys the plugin, don't use after this.
-     *
-     */
+    /** Destroys the plugin, don't use after this. */
     destroy(): void;
@@ -105,19 +131,20 @@ }
  *
- * @class
  * @memberof PIXI
  */
 export declare class CountLimiter {
+    /** The maximum number of items that can be prepared each frame. */
     maxItemsPerFrame: number;
+    /**
+     * The number of items that can be prepared in the current frame. */
     itemsLeft: number;
     /**
-     * @param {number} maxItemsPerFrame - The maximum number of items that can be prepared each frame.
+     * @param maxItemsPerFrame - The maximum number of items that can be prepared each frame.
      */
     constructor(maxItemsPerFrame: number);
-    /**
-     * Resets any counting properties to start fresh on a new frame.
-     */
+    /** Resets any counting properties to start fresh on a new frame. */
     beginFrame(): void;
     /**
      * Checks to see if another item can be uploaded. This should only be called once per item.
-     * @return {boolean} If the item is allowed to be uploaded.
+     *
+     * @return If the item is allowed to be uploaded.
      */
@@ -168,4 +195,3 @@ allowedToUpload(): boolean;
  *
- * @class
- * @extends PIXI.BasePrepare
+ *
  * @memberof PIXI
@@ -172,0 +198,0 @@ */

package.json

 {
   "name": "@pixi/prepare",
-  "version": "6.1.3",
+  "version": "6.2.0",
   "main": "dist/cjs/prepare.js",
@@ -28,10 +28,10 @@ "module": "dist/esm/prepare.js",
   "peerDependencies": {
-    "@pixi/core": "6.1.3",
-    "@pixi/display": "6.1.3",
-    "@pixi/graphics": "6.1.3",
-    "@pixi/settings": "6.1.3",
-    "@pixi/text": "6.1.3",
-    "@pixi/ticker": "6.1.3"
+    "@pixi/core": "6.2.0",
+    "@pixi/display": "6.2.0",
+    "@pixi/graphics": "6.2.0",
+    "@pixi/settings": "6.2.0",
+    "@pixi/text": "6.2.0",
+    "@pixi/ticker": "6.2.0"
   },
-  "gitHead": "2342b551124751206078602eb0e4408df230923e"
+  "gitHead": "793f21c0d0f2d2a423bd4339f40a569e1ea68711"
 }

No alert changes

Worsened metrics

Total package byte prevSize

328598

decreased by-3.82%

Lines of code

2129

decreased by-6.99%

No dependency changes