@mlightcad/data-model 1.1.2 → 1.1.4

package/lib/base/AcDbObject.js

@@ -2,13 +2,34 @@ import { AcCmObject, defaults } from '@mlightcad/common';
 import { uid } from 'uid';
 import { acdbHostApplicationServices } from './AcDbHostApplicationServices';
 /**
- * The base class for all objects that reside in drawing database.
+ * The base class for all objects that reside in a drawing database.
+ *
+ * This class provides the fundamental functionality for all database objects,
+ * including attribute management, object identification, and database association.
+ * It serves as the foundation for entities, tables, and other database objects.
+ *
+ * @template ATTRS - The type of attributes this object can have
+ *
+ * @example
+ * ```typescript
+ * class MyEntity extends AcDbObject<MyEntityAttrs> {
+ *   constructor(attrs?: Partial<MyEntityAttrs>) {
+ *     super(attrs);
+ *   }
+ * }
+ * ```
  */
 var AcDbObject = /** @class */ (function () {
     /**
-     * Default constructor.
-     * @param attrs Input attribute values of this object
-     * @param defaultAttrs Input default values of attributes of this object.
+     * Creates a new AcDbObject instance.
+     *
+     * @param attrs - Input attribute values for this object
+     * @param defaultAttrs - Default values for attributes of this object
+     *
+     * @example
+     * ```typescript
+     * const obj = new AcDbObject({ objectId: '123' });
+     * ```
      */
     function AcDbObject(attrs, defaultAttrs) {
         attrs = attrs || {};
@@ -17,7 +38,15 @@ var AcDbObject = /** @class */ (function () {
     }
     Object.defineProperty(AcDbObject.prototype, "attrs", {
         /**
-         * Attributes of this object
+         * Gets the attributes object for this AcDbObject.
+         *
+         * @returns The AcCmObject instance containing all attributes
+         *
+         * @example
+         * ```typescript
+         * const attrs = obj.attrs;
+         * const value = attrs.get('someAttribute');
+         * ```
          */
         get: function () {
             return this._attrs;
@@ -26,9 +55,23 @@ var AcDbObject = /** @class */ (function () {
         configurable: true
     });
     /**
-     * Get value of the specified attribute. One exception will be thrown if the specified attribute doesn't exist.
-     * @param attrName Input attribute name
-     * @returns Return value of the specified attribute
+     * Gets the value of the specified attribute.
+     *
+     * This method will throw an exception if the specified attribute doesn't exist.
+     * Use getAttrWithoutException() if you want to handle missing attributes gracefully.
+     *
+     * @param attrName - The name of the attribute to retrieve
+     * @returns The value of the specified attribute
+     * @throws {Error} When the specified attribute doesn't exist
+     *
+     * @example
+     * ```typescript
+     * try {
+     *   const value = obj.getAttr('objectId');
+     * } catch (error) {
+     *   console.error('Attribute not found');
+     * }
+     * ```
      */
     AcDbObject.prototype.getAttr = function (attrName) {
         var value = this._attrs.get(attrName);
@@ -38,33 +81,67 @@ var AcDbObject = /** @class */ (function () {
         return value;
     };
     /**
-     * Get value of the specified attribute. Return undefined if the specified attribute doesn't exist.
-     * @param attrName Input attribute name
-     * @returns Return value of the specified attribute. Return undefined if the specified attribute
-     * doesn't exist.
+     * Gets the value of the specified attribute without throwing an exception.
+     *
+     * This method returns undefined if the specified attribute doesn't exist,
+     * making it safer for optional attributes.
+     *
+     * @param attrName - The name of the attribute to retrieve
+     * @returns The value of the specified attribute, or undefined if it doesn't exist
+     *
+     * @example
+     * ```typescript
+     * const value = obj.getAttrWithoutException('optionalAttribute');
+     * if (value !== undefined) {
+     *   // Use the value
+     * }
+     * ```
      */
     AcDbObject.prototype.getAttrWithoutException = function (attrName) {
         return this._attrs.get(attrName);
     };
     /**
-     * Set value of the attribute
-     * @param attrName Input attribute name
-     * @param val Input value of the attribute
+     * Sets the value of an attribute.
+     *
+     * @param attrName - The name of the attribute to set
+     * @param val - The value to assign to the attribute
+     *
+     * @example
+     * ```typescript
+     * obj.setAttr('objectId', 'new-id-123');
+     * ```
      */
     AcDbObject.prototype.setAttr = function (attrName, val) {
         this._attrs.set(attrName, val);
     };
     Object.defineProperty(AcDbObject.prototype, "objectId", {
         /**
-         * Object id.
+         * Gets the object ID.
+         *
+         * AutoCAD uses 64-bit integers to represent handles, which exceed the maximum
+         * integer value of JavaScript. Therefore, strings are used to represent object handles.
          *
-         * AutoCAD uses 64-bit integer to represent handle. It exceeds the maximum integer value
-         * (Number.MAX_SAFE_INTEGER, 0x1F FFFF FFFF FFF) of JavaScript number. So string is used to represent
-         * the handle of one object.
+         * @returns The object ID as a string
+         *
+         * @example
+         * ```typescript
+         * const id = obj.objectId;
+         * console.log(`Object ID: ${id}`);
+         * ```
          */
         get: function () {
             return this.getAttr('objectId');
         },
+        /**
+         * Sets the object ID.
+         *
+         * @param value - The new object ID
+         *
+         * @example
+         * ```typescript
+         * obj.objectId = 'new-object-id';
+         * ```
+         */
         set: function (value) {
             this._attrs.set('objectId', value);
         },
@@ -73,11 +150,28 @@ var AcDbObject = /** @class */ (function () {
     });
     Object.defineProperty(AcDbObject.prototype, "ownerId", {
         /**
-         * The object Id of the owner of the object.
+         * Gets the object ID of the owner of this object.
+         *
+         * @returns The owner object ID
+         *
+         * @example
+         * ```typescript
+         * const ownerId = obj.ownerId;
+         * ```
          */
         get: function () {
             return this.getAttr('ownerId');
         },
+        /**
+         * Sets the object ID of the owner of this object.
+         *
+         * @param value - The new owner object ID
+         *
+         * @example
+         * ```typescript
+         * obj.ownerId = 'parent-object-id';
+         * ```
+         */
         set: function (value) {
             this._attrs.set('ownerId', value);
         },
@@ -86,15 +180,37 @@ var AcDbObject = /** @class */ (function () {
     });
     Object.defineProperty(AcDbObject.prototype, "database", {
         /**
-         * The database in which the object is resident. When one object isn't added into database, the database
-         * property of this object will be current working database. After it is added into database, it will be
-         * set automatically. So it means you should never set its value by your own.
+         * Gets the database in which this object is resident.
+         *
+         * When an object isn't added to a database, this property returns the current
+         * working database. After it is added to a database, it will be set automatically.
+         * You should never set this value manually.
+         *
+         * @returns The database this object belongs to
+         *
+         * @example
+         * ```typescript
+         * const db = obj.database;
+         * ```
          */
         get: function () {
             return this._database
                 ? this._database
                 : acdbHostApplicationServices().workingDatabase;
         },
+        /**
+         * Sets the database for this object.
+         *
+         * This is typically set automatically when the object is added to a database.
+         * Manual setting should be avoided unless you know what you're doing.
+         *
+         * @param db - The database to associate with this object
+         *
+         * @example
+         * ```typescript
+         * obj.database = myDatabase;
+         * ```
+         */
         set: function (db) {
             this._database = db;
         },
@@ -102,8 +218,16 @@ var AcDbObject = /** @class */ (function () {
         configurable: true
     });
     /**
-     * Closes the object. All changes made to the object since it was opened are committed to the database,
-     * and a "closed" notification is sent.
+     * Closes the object.
+     *
+     * All changes made to the object since it was opened are committed to the database,
+     * and a "closed" notification is sent. This method can be overridden by subclasses
+     * to provide specific cleanup behavior.
+     *
+     * @example
+     * ```typescript
+     * obj.close();
+     * ```
      */
     AcDbObject.prototype.close = function () { };
     return AcDbObject;

package/lib/base/AcDbObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbObject.js","sourceRoot":"","sources":["../../src/base/AcDbObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EAEV,QAAQ,EACT,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAGzB,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAA;AAS3E;;GAEG;AACH;IAIE;;;;OAIG;IACH,oBAAY,KAAsB,EAAE,YAA6B;QAC/D,KAAK,GAAG,KAAK,IAAI,EAAE,CAAA;QACnB,QAAQ,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,CAAC,CAAA;QACpC,IAAI,CAAC,MAAM,GAAG,IAAI,UAAU,CAAQ,KAAK,EAAE,YAAY,CAAC,CAAA;IAC1D,CAAC;IAKD,sBAAI,6BAAK;QAHT;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,MAAM,CAAA;QACpB,CAAC;;;OAAA;IAED;;;;OAIG;IACH,4BAAO,GAAP,UAAQ,QAA8B;QACpC,IAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACvC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,uCAAgC,QAAQ,mCAAgC,CACzE,CAAA;QACH,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;OAKG;IACH,4CAAuB,GAAvB,UAAwB,QAA8B;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IAClC,CAAC;IAED;;;;OAIG;IACH,4BAAO,GAAP,UAAwC,QAAW,EAAE,GAAc;QACjE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;IAChC,CAAC;IASD,sBAAI,gCAAQ;QAPZ;;;;;;WAMG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QACjC,CAAC;aACD,UAAa,KAAmB;YAC9B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACpC,CAAC;;;OAHA;IAQD,sBAAI,+BAAO;QAHX;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;QAChC,CAAC;aACD,UAAY,KAAmB;YAC7B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QACnC,CAAC;;;OAHA;IAUD,sBAAI,gCAAQ;QALZ;;;;WAIG;aACH;YACE,OAAO,IAAI,CAAC,SAAS;gBACnB,CAAC,CAAC,IAAI,CAAC,SAAS;gBAChB,CAAC,CAAC,2BAA2B,EAAE,CAAC,eAAe,CAAA;QACnD,CAAC;aACD,UAAa,EAAgB;YAC3B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;QACrB,CAAC;;;OAHA;IAKD;;;OAGG;IACH,0BAAK,GAAL,cAAS,CAAC;IACZ,iBAAC;AAAD,CAAC,AAnGD,IAmGC"}
+{"version":3,"file":"AcDbObject.js","sourceRoot":"","sources":["../../src/base/AcDbObject.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,UAAU,EAEV,QAAQ,EACT,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EAAE,GAAG,EAAE,MAAM,KAAK,CAAA;AAGzB,OAAO,EAAE,2BAA2B,EAAE,MAAM,+BAA+B,CAAA;AAkB3E;;;;;;;;;;;;;;;;;GAiBG;AACH;IAME;;;;;;;;;;OAUG;IACH,oBAAY,KAAsB,EAAE,YAA6B;QAC/D,KAAK,GAAG,KAAK,IAAI,EAAE,CAAA;QACnB,QAAQ,CAAC,KAAK,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE,EAAE,CAAC,CAAA;QACpC,IAAI,CAAC,MAAM,GAAG,IAAI,UAAU,CAAQ,KAAK,EAAE,YAAY,CAAC,CAAA;IAC1D,CAAC;IAaD,sBAAI,6BAAK;QAXT;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,MAAM,CAAA;QACpB,CAAC;;;OAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,4BAAO,GAAP,UAAQ,QAA8B;QACpC,IAAM,KAAK,GAAG,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;QACvC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,MAAM,IAAI,KAAK,CACb,uCAAgC,QAAQ,mCAAgC,CACzE,CAAA;QACH,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;;;;;;;;;;;;;;;OAgBG;IACH,4CAAuB,GAAvB,UAAwB,QAA8B;QACpD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAA;IAClC,CAAC;IAED;;;;;;;;;;OAUG;IACH,4BAAO,GAAP,UAAwC,QAAW,EAAE,GAAc;QACjE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAA;IAChC,CAAC;IAgBD,sBAAI,gCAAQ;QAdZ;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,CAAA;QACjC,CAAC;QAED;;;;;;;;;WASG;aACH,UAAa,KAAmB;YAC9B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAA;QACpC,CAAC;;;OAdA;IA0BD,sBAAI,+BAAO;QAVX;;;;;;;;;WASG;aACH;YACE,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;QAChC,CAAC;QAED;;;;;;;;;WASG;aACH,UAAY,KAAmB;YAC7B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,SAAS,EAAE,KAAK,CAAC,CAAA;QACnC,CAAC;;;OAdA;IA8BD,sBAAI,gCAAQ;QAdZ;;;;;;;;;;;;;WAaG;aACH;YACE,OAAO,IAAI,CAAC,SAAS;gBACnB,CAAC,CAAC,IAAI,CAAC,SAAS;gBAChB,CAAC,CAAC,2BAA2B,EAAE,CAAC,eAAe,CAAA;QACnD,CAAC;QAED;;;;;;;;;;;;WAYG;aACH,UAAa,EAAgB;YAC3B,IAAI,CAAC,SAAS,GAAG,EAAE,CAAA;QACrB,CAAC;;;OAjBA;IAmBD;;;;;;;;;;;OAWG;IACH,0BAAK,GAAL,cAAS,CAAC;IACZ,iBAAC;AAAD,CAAC,AArND,IAqNC"}

package/lib/converter/AcDbBatchProcessing.d.ts

@@ -1,42 +1,144 @@
 type AcDbChunkProcessingCallback = (start: number, end: number) => Promise<void>;
 /**
- * This class is used to break up the work into smaller chunks that are executed asynchronously.
- * This is often referred to "batch processing" or "cooperative multitasking," where the
+ * Class used to break up work into smaller chunks that are executed asynchronously.
+ *
+ * This is often referred to as "batch processing" or "cooperative multitasking," where the
  * time-consuming task is broken into smaller pieces and executed in small intervals to allow
  * the UI to remain responsive.
+ *
+ * @example
+ * ```typescript
+ * const batchProcessor = new AcDbBatchProcessing(1000, 10, 50);
+ * await batchProcessor.processChunk(async (start, end) => {
+ *   // Process items from start to end
+ *   for (let i = start; i < end; i++) {
+ *     // Process item i
+ *   }
+ * });
+ * ```
  */
 export declare class AcDbBatchProcessing {
+    /** Total number of items to process */
     private _count;
+    /** Number of chunks to process */
     private _numerOfChunk;
+    /** Number of items in one chunk */
     private _chunkSize;
+    /** Minimum number of items in one chunk */
     private _minimumChunkSize;
     /**
-     * Construct one instance of this class
-     * @param count Input the total number of items to process
-     * @param numerOfChunk Input the number of chunks to process
-     * @param minimumChunkSize Input the minimum number of items in one chunk. If it is greater
+     * Creates a new AcDbBatchProcessing instance.
+     *
+     * @param count - The total number of items to process
+     * @param numerOfChunk - The number of chunks to process
+     * @param minimumChunkSize - The minimum number of items in one chunk. If it is greater
      * than the total number of items to process, the total number is used.
+     *
+     * @example
+     * ```typescript
+     * const batchProcessor = new AcDbBatchProcessing(1000, 10, 50);
+     * ```
      */
     constructor(count: number, numerOfChunk: number, minimumChunkSize: number);
     /**
-     * The total number of items to process
+     * Gets the total number of items to process.
+     *
+     * @returns The total number of items to process
+     *
+     * @example
+     * ```typescript
+     * const totalItems = batchProcessor.count;
+     * ```
      */
     get count(): number;
     /**
-     * The number of chunks to process
+     * Gets the number of chunks to process.
+     *
+     * @returns The number of chunks to process
+     *
+     * @example
+     * ```typescript
+     * const numberOfChunks = batchProcessor.numerOfChunk;
+     * ```
      */
     get numerOfChunk(): number;
     /**
-     * The minimum number of items in one chunk.
+     * Gets the minimum number of items in one chunk.
+     *
+     * @returns The minimum number of items in one chunk
+     *
+     * @example
+     * ```typescript
+     * const minChunkSize = batchProcessor.minimumChunkSize;
+     * ```
      */
     get minimumChunkSize(): number;
+    /**
+     * Sets the minimum number of items in one chunk.
+     *
+     * @param value - The new minimum chunk size
+     *
+     * @example
+     * ```typescript
+     * batchProcessor.minimumChunkSize = 100;
+     * ```
+     */
     set minimumChunkSize(value: number);
     /**
-     * The number of items in one chunk
+     * Gets the number of items in one chunk.
+     *
+     * @returns The number of items in one chunk
+     *
+     * @example
+     * ```typescript
+     * const chunkSize = batchProcessor.chunkSize;
+     * ```
      */
     get chunkSize(): number;
+    /**
+     * Calculates the chunk size based on the total count, number of chunks, and minimum chunk size.
+     *
+     * @example
+     * ```typescript
+     * batchProcessor.calculateChunkSize();
+     * ```
+     */
     private calculateChunkSize;
+    /**
+     * Schedules a task to be executed asynchronously.
+     *
+     * This method uses requestAnimationFrame in browser environments or setTimeout
+     * in Node.js environments to schedule the task.
+     *
+     * @param callback - The callback function to schedule
+     *
+     * @example
+     * ```typescript
+     * batchProcessor.scheduleTask(() => {
+     *   // Task to be executed asynchronously
+     * });
+     * ```
+     */
     private scheduleTask;
+    /**
+     * Processes items in chunks using the provided callback function.
+     *
+     * This method breaks up the work into chunks and processes each chunk
+     * asynchronously, allowing the UI to remain responsive.
+     *
+     * @param callback - The callback function to execute for each chunk
+     * @returns Promise that resolves when all chunks have been processed
+     *
+     * @example
+     * ```typescript
+     * await batchProcessor.processChunk(async (start, end) => {
+     *   for (let i = start; i < end; i++) {
+     *     // Process item i
+     *     await processItem(i);
+     *   }
+     * });
+     * ```
+     */
     processChunk(callback: AcDbChunkProcessingCallback): Promise<void>;
 }
 export {};

package/lib/converter/AcDbBatchProcessing.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbBatchProcessing.d.ts","sourceRoot":"","sources":["../../src/converter/AcDbBatchProcessing.ts"],"names":[],"mappings":"AACA,KAAK,2BAA2B,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;AAEhF;;;;;GAKG;AACH,qBAAa,mBAAmB;IAC9B,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,aAAa,CAAQ;IAC7B,OAAO,CAAC,UAAU,CAAa;IAC/B,OAAO,CAAC,iBAAiB,CAAa;IAEtC;;;;;;OAMG;gBACS,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM;IAOzE;;OAEG;IACH,IAAI,KAAK,WAER;IAED;;OAEG;IACH,IAAI,YAAY,WAEf;IAED;;OAEG;IACH,IAAI,gBAAgB,IAGQ,MAAM,CADjC;IACD,IAAI,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAGjC;IAED;;OAEG;IACH,IAAI,SAAS,WAEZ;IAED,OAAO,CAAC,kBAAkB;IAS1B,OAAO,CAAC,YAAY;IAcP,YAAY,CAAC,QAAQ,EAAE,2BAA2B;CAqBhE"}
+{"version":3,"file":"AcDbBatchProcessing.d.ts","sourceRoot":"","sources":["../../src/converter/AcDbBatchProcessing.ts"],"names":[],"mappings":"AACA,KAAK,2BAA2B,GAAG,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;AAEhF;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,mBAAmB;IAC9B,uCAAuC;IACvC,OAAO,CAAC,MAAM,CAAQ;IACtB,kCAAkC;IAClC,OAAO,CAAC,aAAa,CAAQ;IAC7B,mCAAmC;IACnC,OAAO,CAAC,UAAU,CAAa;IAC/B,2CAA2C;IAC3C,OAAO,CAAC,iBAAiB,CAAa;IAEtC;;;;;;;;;;;;OAYG;gBACS,KAAK,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM;IAOzE;;;;;;;;;OASG;IACH,IAAI,KAAK,WAER;IAED;;;;;;;;;OASG;IACH,IAAI,YAAY,WAEf;IAED;;;;;;;;;OASG;IACH,IAAI,gBAAgB,IAcQ,MAAM,CAZjC;IAED;;;;;;;;;OASG;IACH,IAAI,gBAAgB,CAAC,KAAK,EAAE,MAAM,EAGjC;IAED;;;;;;;;;OASG;IACH,IAAI,SAAS,WAEZ;IAED;;;;;;;OAOG;IACH,OAAO,CAAC,kBAAkB;IAS1B;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,YAAY;IAapB;;;;;;;;;;;;;;;;;;OAkBG;IACU,YAAY,CAAC,QAAQ,EAAE,2BAA2B;CAqBhE"}

package/lib/converter/AcDbBatchProcessing.js

@@ -35,21 +35,41 @@ var __generator = (this && this.__generator) || function (thisArg, body) {
     }
 };
 /**
- * This class is used to break up the work into smaller chunks that are executed asynchronously.
- * This is often referred to "batch processing" or "cooperative multitasking," where the
+ * Class used to break up work into smaller chunks that are executed asynchronously.
+ *
+ * This is often referred to as "batch processing" or "cooperative multitasking," where the
  * time-consuming task is broken into smaller pieces and executed in small intervals to allow
  * the UI to remain responsive.
+ *
+ * @example
+ * ```typescript
+ * const batchProcessor = new AcDbBatchProcessing(1000, 10, 50);
+ * await batchProcessor.processChunk(async (start, end) => {
+ *   // Process items from start to end
+ *   for (let i = start; i < end; i++) {
+ *     // Process item i
+ *   }
+ * });
+ * ```
  */
 var AcDbBatchProcessing = /** @class */ (function () {
     /**
-     * Construct one instance of this class
-     * @param count Input the total number of items to process
-     * @param numerOfChunk Input the number of chunks to process
-     * @param minimumChunkSize Input the minimum number of items in one chunk. If it is greater
+     * Creates a new AcDbBatchProcessing instance.
+     *
+     * @param count - The total number of items to process
+     * @param numerOfChunk - The number of chunks to process
+     * @param minimumChunkSize - The minimum number of items in one chunk. If it is greater
      * than the total number of items to process, the total number is used.
+     *
+     * @example
+     * ```typescript
+     * const batchProcessor = new AcDbBatchProcessing(1000, 10, 50);
+     * ```
      */
     function AcDbBatchProcessing(count, numerOfChunk, minimumChunkSize) {
+        /** Number of items in one chunk */
         this._chunkSize = -1;
+        /** Minimum number of items in one chunk */
         this._minimumChunkSize = 50;
         this._count = count;
         this._numerOfChunk = numerOfChunk < 1 ? 1 : numerOfChunk;
@@ -58,7 +78,14 @@ var AcDbBatchProcessing = /** @class */ (function () {
     }
     Object.defineProperty(AcDbBatchProcessing.prototype, "count", {
         /**
-         * The total number of items to process
+         * Gets the total number of items to process.
+         *
+         * @returns The total number of items to process
+         *
+         * @example
+         * ```typescript
+         * const totalItems = batchProcessor.count;
+         * ```
          */
         get: function () {
             return this._count;
@@ -68,7 +95,14 @@ var AcDbBatchProcessing = /** @class */ (function () {
     });
     Object.defineProperty(AcDbBatchProcessing.prototype, "numerOfChunk", {
         /**
-         * The number of chunks to process
+         * Gets the number of chunks to process.
+         *
+         * @returns The number of chunks to process
+         *
+         * @example
+         * ```typescript
+         * const numberOfChunks = batchProcessor.numerOfChunk;
+         * ```
          */
         get: function () {
             return this._numerOfChunk;
@@ -78,11 +112,28 @@ var AcDbBatchProcessing = /** @class */ (function () {
     });
     Object.defineProperty(AcDbBatchProcessing.prototype, "minimumChunkSize", {
         /**
-         * The minimum number of items in one chunk.
+         * Gets the minimum number of items in one chunk.
+         *
+         * @returns The minimum number of items in one chunk
+         *
+         * @example
+         * ```typescript
+         * const minChunkSize = batchProcessor.minimumChunkSize;
+         * ```
          */
         get: function () {
             return this._minimumChunkSize;
         },
+        /**
+         * Sets the minimum number of items in one chunk.
+         *
+         * @param value - The new minimum chunk size
+         *
+         * @example
+         * ```typescript
+         * batchProcessor.minimumChunkSize = 100;
+         * ```
+         */
         set: function (value) {
             this._minimumChunkSize = value;
             this.calculateChunkSize();
@@ -92,7 +143,14 @@ var AcDbBatchProcessing = /** @class */ (function () {
     });
     Object.defineProperty(AcDbBatchProcessing.prototype, "chunkSize", {
         /**
-         * The number of items in one chunk
+         * Gets the number of items in one chunk.
+         *
+         * @returns The number of items in one chunk
+         *
+         * @example
+         * ```typescript
+         * const chunkSize = batchProcessor.chunkSize;
+         * ```
          */
         get: function () {
             return this._chunkSize;
@@ -100,6 +158,14 @@ var AcDbBatchProcessing = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    /**
+     * Calculates the chunk size based on the total count, number of chunks, and minimum chunk size.
+     *
+     * @example
+     * ```typescript
+     * batchProcessor.calculateChunkSize();
+     * ```
+     */
     AcDbBatchProcessing.prototype.calculateChunkSize = function () {
         var demicalChunkSize = this._count / this._numerOfChunk;
         if (demicalChunkSize < this._minimumChunkSize) {
@@ -108,6 +174,21 @@ var AcDbBatchProcessing = /** @class */ (function () {
         this._chunkSize =
             demicalChunkSize < 1 ? this._count : Math.floor(demicalChunkSize);
     };
+    /**
+     * Schedules a task to be executed asynchronously.
+     *
+     * This method uses requestAnimationFrame in browser environments or setTimeout
+     * in Node.js environments to schedule the task.
+     *
+     * @param callback - The callback function to schedule
+     *
+     * @example
+     * ```typescript
+     * batchProcessor.scheduleTask(() => {
+     *   // Task to be executed asynchronously
+     * });
+     * ```
+     */
     AcDbBatchProcessing.prototype.scheduleTask = function (callback) {
         if (typeof window !== 'undefined' &&
             typeof window.requestAnimationFrame === 'function') {
@@ -119,7 +200,25 @@ var AcDbBatchProcessing = /** @class */ (function () {
             setTimeout(callback, 0);
         }
     };
-    // Use the ChunkProcessingCallback type for the callback parameter
+    /**
+     * Processes items in chunks using the provided callback function.
+     *
+     * This method breaks up the work into chunks and processes each chunk
+     * asynchronously, allowing the UI to remain responsive.
+     *
+     * @param callback - The callback function to execute for each chunk
+     * @returns Promise that resolves when all chunks have been processed
+     *
+     * @example
+     * ```typescript
+     * await batchProcessor.processChunk(async (start, end) => {
+     *   for (let i = start; i < end; i++) {
+     *     // Process item i
+     *     await processItem(i);
+     *   }
+     * });
+     * ```
+     */
     AcDbBatchProcessing.prototype.processChunk = function (callback) {
         return __awaiter(this, void 0, void 0, function () {
             var currentIndex, processNextChunk;

package/lib/converter/AcDbBatchProcessing.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbBatchProcessing.js","sourceRoot":"","sources":["../../src/converter/AcDbBatchProcessing.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA;;;;;GAKG;AACH;IAME;;;;;;OAMG;IACH,6BAAY,KAAa,EAAE,YAAoB,EAAE,gBAAwB;QAVjE,eAAU,GAAW,CAAC,CAAC,CAAA;QACvB,sBAAiB,GAAW,EAAE,CAAA;QAUpC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,IAAI,CAAC,aAAa,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAA;QACxD,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;QACzC,IAAI,CAAC,kBAAkB,EAAE,CAAA;IAC3B,CAAC;IAKD,sBAAI,sCAAK;QAHT;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,MAAM,CAAA;QACpB,CAAC;;;OAAA;IAKD,sBAAI,6CAAY;QAHhB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,aAAa,CAAA;QAC3B,CAAC;;;OAAA;IAKD,sBAAI,iDAAgB;QAHpB;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,iBAAiB,CAAA;QAC/B,CAAC;aACD,UAAqB,KAAa;YAChC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAA;YAC9B,IAAI,CAAC,kBAAkB,EAAE,CAAA;QAC3B,CAAC;;;OAJA;IASD,sBAAI,0CAAS;QAHb;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;;;OAAA;IAEO,gDAAkB,GAA1B;QACE,IAAI,gBAAgB,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAA;QACvD,IAAI,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC9C,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QAClE,CAAC;QACD,IAAI,CAAC,UAAU;YACb,gBAAgB,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;IACrE,CAAC;IAEO,0CAAY,GAApB,UAAqB,QAAoB;QACvC,IACE,OAAO,MAAM,KAAK,WAAW;YAC7B,OAAO,MAAM,CAAC,qBAAqB,KAAK,UAAU,EAClD,CAAC;YACD,iDAAiD;YACjD,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAA;QACxC,CAAC;aAAM,CAAC;YACN,oCAAoC;YACpC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;QACzB,CAAC;IACH,CAAC;IAED,kEAAkE;IACrD,0CAAY,GAAzB,UAA0B,QAAqC;;;;;;;wBACzD,YAAY,GAAG,CAAC,CAAA;wBAEd,gBAAgB,GAAG;;;;;wCACjB,KAAK,GAAG,YAAY,CAAA;wCACpB,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;wCAEjE,oDAAoD;wCACpD,qBAAM,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,EAAA;;wCAD1B,oDAAoD;wCACpD,SAA0B,CAAA;wCAE1B,YAAY,GAAG,GAAG,CAAA;wCAElB,8DAA8D;wCAC9D,IAAI,YAAY,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;4CAC/B,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAA,CAAC,yDAAyD;wCAC/F,CAAC;;;;6BACF,CAAA;wBAED,mCAAmC;wBACnC,qBAAM,gBAAgB,EAAE,EAAA;;wBADxB,mCAAmC;wBACnC,SAAwB,CAAA;;;;;KACzB;IACH,0BAAC;AAAD,CAAC,AAhGD,IAgGC"}
+{"version":3,"file":"AcDbBatchProcessing.js","sourceRoot":"","sources":["../../src/converter/AcDbBatchProcessing.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAGA;;;;;;;;;;;;;;;;;GAiBG;AACH;IAUE;;;;;;;;;;;;OAYG;IACH,6BAAY,KAAa,EAAE,YAAoB,EAAE,gBAAwB;QAlBzE,mCAAmC;QAC3B,eAAU,GAAW,CAAC,CAAC,CAAA;QAC/B,2CAA2C;QACnC,sBAAiB,GAAW,EAAE,CAAA;QAgBpC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAA;QACnB,IAAI,CAAC,aAAa,GAAG,YAAY,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,CAAA;QACxD,IAAI,CAAC,iBAAiB,GAAG,gBAAgB,CAAA;QACzC,IAAI,CAAC,kBAAkB,EAAE,CAAA;IAC3B,CAAC;IAYD,sBAAI,sCAAK;QAVT;;;;;;;;;WASG;aACH;YACE,OAAO,IAAI,CAAC,MAAM,CAAA;QACpB,CAAC;;;OAAA;IAYD,sBAAI,6CAAY;QAVhB;;;;;;;;;WASG;aACH;YACE,OAAO,IAAI,CAAC,aAAa,CAAA;QAC3B,CAAC;;;OAAA;IAYD,sBAAI,iDAAgB;QAVpB;;;;;;;;;WASG;aACH;YACE,OAAO,IAAI,CAAC,iBAAiB,CAAA;QAC/B,CAAC;QAED;;;;;;;;;WASG;aACH,UAAqB,KAAa;YAChC,IAAI,CAAC,iBAAiB,GAAG,KAAK,CAAA;YAC9B,IAAI,CAAC,kBAAkB,EAAE,CAAA;QAC3B,CAAC;;;OAfA;IA2BD,sBAAI,0CAAS;QAVb;;;;;;;;;WASG;aACH;YACE,OAAO,IAAI,CAAC,UAAU,CAAA;QACxB,CAAC;;;OAAA;IAED;;;;;;;OAOG;IACK,gDAAkB,GAA1B;QACE,IAAI,gBAAgB,GAAG,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC,aAAa,CAAA;QACvD,IAAI,gBAAgB,GAAG,IAAI,CAAC,iBAAiB,EAAE,CAAC;YAC9C,gBAAgB,GAAG,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,iBAAiB,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;QAClE,CAAC;QACD,IAAI,CAAC,UAAU;YACb,gBAAgB,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,CAAC,CAAA;IACrE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACK,0CAAY,GAApB,UAAqB,QAAoB;QACvC,IACE,OAAO,MAAM,KAAK,WAAW;YAC7B,OAAO,MAAM,CAAC,qBAAqB,KAAK,UAAU,EAClD,CAAC;YACD,iDAAiD;YACjD,MAAM,CAAC,qBAAqB,CAAC,QAAQ,CAAC,CAAA;QACxC,CAAC;aAAM,CAAC;YACN,oCAAoC;YACpC,UAAU,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAA;QACzB,CAAC;IACH,CAAC;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACU,0CAAY,GAAzB,UAA0B,QAAqC;;;;;;;wBACzD,YAAY,GAAG,CAAC,CAAA;wBAEd,gBAAgB,GAAG;;;;;wCACjB,KAAK,GAAG,YAAY,CAAA;wCACpB,GAAG,GAAG,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,MAAM,CAAC,CAAA;wCAEjE,oDAAoD;wCACpD,qBAAM,QAAQ,CAAC,KAAK,EAAE,GAAG,CAAC,EAAA;;wCAD1B,oDAAoD;wCACpD,SAA0B,CAAA;wCAE1B,YAAY,GAAG,GAAG,CAAA;wCAElB,8DAA8D;wCAC9D,IAAI,YAAY,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;4CAC/B,IAAI,CAAC,YAAY,CAAC,gBAAgB,CAAC,CAAA,CAAC,yDAAyD;wCAC/F,CAAC;;;;6BACF,CAAA;wBAED,mCAAmC;wBACnC,qBAAM,gBAAgB,EAAE,EAAA;;wBADxB,mCAAmC;wBACnC,SAAwB,CAAA;;;;;KACzB;IACH,0BAAC;AAAD,CAAC,AA1LD,IA0LC"}