@itwin/core-i18n 4.1.0-dev.56 → 4.1.0-dev.62

package/lib/cjs/test/webpack/bundled-tests.js

@@ -22038,28 +22038,36 @@ __webpack_require__.r(__webpack_exports__);
 * Copyright (c) Bentley Systems, Incorporated. All rights reserved.
 * See LICENSE.md in the project root for license terms and full copyright notice.
 *--------------------------------------------------------------------------------------------*/
-/** @internal the default options when constructing yield managers */
+/** @packageDocumentation
+ * @module Utils
+ */
 const defaultYieldManagerOptions = {
     iterationsBeforeYield: 1000,
 };
-/**
- * @internal
- * An object allowing code to optionally yield with some frequency.
- * useful in some intense loops that make processes unresponsive.
- * primarily a workaround for: https://github.com/nodejs/node-addon-api/issues/1140
- * @note see [[defaultYieldManagerOptions]], the default amount of times it must be called to cause an actual yield is 1000
+/** Provides a mechanism by which a loop can be made to periodically yield control back to the browser/node environment.
+ * This can alleviate [performance and memory consumption issues](https://github.com/nodejs/node-addon-api/issues/1140).
+ * It maintains a count of the number of iterations that have occurred since the last yield.
+ * The constructor specifies how many iterations of the loop are permitted before yielding.
+ * The loop should `await` [[allowYield]] on each iteration.
+ * [[allowYield]] will yield (and reset the iteration counter) if the counter exceeds the specified maximum.
+ * @public
  */
 class YieldManager {
+    /** Constructor.
+     * @param options Options customizing the yield behavior. Omitted properties are assigned their default values.
+     */
     constructor(options = {}) {
         this._counter = 0;
         this.options = { ...defaultYieldManagerOptions, ...options };
     }
+    /** Increment the iteration counter, yielding control and resetting the counter if [[options.iterationsBeforeYield]] is exceeded. */
     async allowYield() {
         this._counter = (this._counter + 1) % this.options.iterationsBeforeYield;
         if (this._counter === 0) {
             await this.actualYield();
         }
     }
+    /** @internal */
     async actualYield() {
         await new Promise((r) => setTimeout(r, 0));
     }