@mlightcad/data-model 1.1.2 → 1.1.3

package/lib/database/AcDbLinetypeTable.js

@@ -15,11 +15,30 @@ var __extends = (this && this.__extends) || (function () {
 })();
 import { AcDbSymbolTable } from './AcDbSymbolTable';
 /**
- * This class is the symbol table for line type table records. It represents the line types within a
- * drawing database.
+ * Symbol table for linetype table records.
+ *
+ * This class manages linetype table records which represent line types within a
+ * drawing database. Line types define the pattern of dashes, dots, and spaces
+ * used to display lines and curves in the drawing.
+ *
+ * @example
+ * ```typescript
+ * const linetypeTable = new AcDbLinetypeTable(database);
+ * const linetype = linetypeTable.getAt('Continuous');
+ * ```
  */
 var AcDbLinetypeTable = /** @class */ (function (_super) {
     __extends(AcDbLinetypeTable, _super);
+    /**
+     * Creates a new AcDbLinetypeTable instance.
+     *
+     * @param db - The database this linetype table belongs to
+     *
+     * @example
+     * ```typescript
+     * const linetypeTable = new AcDbLinetypeTable(database);
+     * ```
+     */
     function AcDbLinetypeTable(db) {
         return _super.call(this, db) || this;
     }

package/lib/database/AcDbLinetypeTable.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbLinetypeTable.js","sourceRoot":"","sources":["../../src/database/AcDbLinetypeTable.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;;GAGG;AACH;IAAuC,qCAAwC;IAC7E,2BAAY,EAAgB;QAC1B,OAAA,MAAK,YAAC,EAAE,CAAC,SAAA;IACX,CAAC;IACH,wBAAC;AAAD,CAAC,AAJD,CAAuC,eAAe,GAIrD"}
+{"version":3,"file":"AcDbLinetypeTable.js","sourceRoot":"","sources":["../../src/database/AcDbLinetypeTable.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAA;AAEnD;;;;;;;;;;;;GAYG;AACH;IAAuC,qCAAwC;IAC7E;;;;;;;;;OASG;IACH,2BAAY,EAAgB;QAC1B,OAAA,MAAK,YAAC,EAAE,CAAC,SAAA;IACX,CAAC;IACH,wBAAC;AAAD,CAAC,AAdD,CAAuC,eAAe,GAcrD"}

package/lib/database/AcDbLinetypeTableRecord.d.ts

@@ -1,8 +1,11 @@
 import { AcGiBaseLineStyle } from '@mlightcad/graphic-interface';
 import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
 /**
- * The class representing records in the line type table. Each of these records contains the information
- * about a line type in the drawing database.
+ * Represents a record in the line type table within the AutoCAD drawing database.
+ *
+ * Each line type table record contains the information necessary to define a specific line type,
+ * including its pattern, description, and rendering characteristics. Line types define how lines
+ * are drawn, including patterns of dashes, dots, and spaces.
  *
  * Within the line type table record, the dashes (line segments that make up characteristics of the
  * linetype) are stored in a list with an index that is zero based. If the linetype is complex, then
@@ -14,33 +17,62 @@ import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
 export declare class AcDbLinetypeTableRecord extends AcDbSymbolTableRecord {
     private _linetype;
     /**
-     * Default constructor.
+     * Creates a new line type table record.
+     *
+     * @param linetype - The line type style object that defines the visual characteristics
+     *                   and pattern of this line type
      */
     constructor(linetype: AcGiBaseLineStyle);
     /**
-     * The number of dashes in the line type table record. This value is used for DXF group code 73.
+     * Gets the number of dash elements in the line type pattern.
+     *
+     * This value represents the total count of dashes, spaces, dots, and other pattern elements
+     * that make up the line type. It corresponds to DXF group code 73 in the AutoCAD file format.
+     *
+     * @returns The number of pattern elements in the line type
      */
     get numDashes(): number;
     /**
-     * The length (in AutoCAD drawing units--the pattern will appear this length when the line type scale is
-     * 1.0) of the pattern in the line type table record. The pattern length is the total length of all
-     * dashes (including pen up spaces). Embedded shapes or text strings do not add to the pattern length
-     * because they are overlaid and do not interrupt the actual dash pattern.
+     * Gets the total pattern length in AutoCAD drawing units.
+     *
+     * The pattern length represents the total length of all dashes and spaces when the line type
+     * scale is 1.0. This value is used to calculate how the pattern repeats along a line.
+     *
+     * Note: Embedded shapes or text strings do not add to the pattern length because they are
+     * overlaid and do not interrupt the actual dash pattern.
+     *
+     * @returns The total length of the line type pattern in drawing units
      */
     get patternLength(): number;
     /**
-     * Line type description
+     * Gets the description or comments associated with this line type.
+     *
+     * This property provides additional information about the line type, such as its intended
+     * use or any special characteristics.
+     *
+     * @returns The description text for the line type
      */
     get comments(): string;
     /**
-     * Line type information used by renderer.
+     * Gets the line type style object used by the renderer.
+     *
+     * This property provides access to the underlying line type definition that contains
+     * all the visual characteristics and rendering information.
+     *
+     * @returns The line type style object
      */
     get linetype(): AcGiBaseLineStyle;
     /**
-     * Get the length (in AutoCAD drawing units--the dash will appear this length when the linetype scale
-     * is 1.0) of the index'th dash in the line type table record.
-     * @param index Input zero-based index. It must be greater than or equal to zero, but less than the
-     * value of property 'numDashes'.
+     * Gets the length of a specific dash element in the line type pattern.
+     *
+     * Each dash element in the pattern has a specific length that determines how it appears
+     * when the line type is rendered. Positive values represent visible dashes, while negative
+     * values represent spaces (pen up).
+     *
+     * @param index - Zero-based index of the dash element. Must be greater than or equal to zero,
+     *                but less than the value of property 'numDashes'
+     * @returns The length of the specified dash element in drawing units
+     * @throws {Error} When the index is out of range
      */
     dashLengthAt(index: number): number;
 }

package/lib/database/AcDbLinetypeTableRecord.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbLinetypeTableRecord.d.ts","sourceRoot":"","sources":["../../src/database/AcDbLinetypeTableRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAEhE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;;;;;;;;;GAUG;AACH,qBAAa,uBAAwB,SAAQ,qBAAqB;IAChE,OAAO,CAAC,SAAS,CAAmB;IAEpC;;OAEG;gBACS,QAAQ,EAAE,iBAAiB;IAMvC;;OAEG;IACH,IAAI,SAAS,WAEZ;IAED;;;;;OAKG;IACH,IAAI,aAAa,WAEhB;IAED;;OAEG;IACH,IAAI,QAAQ,WAEX;IAED;;OAEG;IACH,IAAI,QAAQ,sBAEX;IAED;;;;;OAKG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM;CAQ3B"}
+{"version":3,"file":"AcDbLinetypeTableRecord.d.ts","sourceRoot":"","sources":["../../src/database/AcDbLinetypeTableRecord.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAA;AAEhE,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;;;;;;;;;;;;GAaG;AACH,qBAAa,uBAAwB,SAAQ,qBAAqB;IAChE,OAAO,CAAC,SAAS,CAAmB;IAEpC;;;;;OAKG;gBACS,QAAQ,EAAE,iBAAiB;IAMvC;;;;;;;OAOG;IACH,IAAI,SAAS,WAEZ;IAED;;;;;;;;;;OAUG;IACH,IAAI,aAAa,WAEhB;IAED;;;;;;;OAOG;IACH,IAAI,QAAQ,WAEX;IAED;;;;;;;OAOG;IACH,IAAI,QAAQ,sBAEX;IAED;;;;;;;;;;;OAWG;IACH,YAAY,CAAC,KAAK,EAAE,MAAM;CAQ3B"}

package/lib/database/AcDbLinetypeTableRecord.js

@@ -15,8 +15,11 @@ var __extends = (this && this.__extends) || (function () {
 })();
 import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
 /**
- * The class representing records in the line type table. Each of these records contains the information
- * about a line type in the drawing database.
+ * Represents a record in the line type table within the AutoCAD drawing database.
+ *
+ * Each line type table record contains the information necessary to define a specific line type,
+ * including its pattern, description, and rendering characteristics. Line types define how lines
+ * are drawn, including patterns of dashes, dots, and spaces.
  *
  * Within the line type table record, the dashes (line segments that make up characteristics of the
  * linetype) are stored in a list with an index that is zero based. If the linetype is complex, then
@@ -28,7 +31,10 @@ import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
 var AcDbLinetypeTableRecord = /** @class */ (function (_super) {
     __extends(AcDbLinetypeTableRecord, _super);
     /**
-     * Default constructor.
+     * Creates a new line type table record.
+     *
+     * @param linetype - The line type style object that defines the visual characteristics
+     *                   and pattern of this line type
      */
     function AcDbLinetypeTableRecord(linetype) {
         var _this = _super.call(this) || this;
@@ -38,7 +44,12 @@ var AcDbLinetypeTableRecord = /** @class */ (function (_super) {
     }
     Object.defineProperty(AcDbLinetypeTableRecord.prototype, "numDashes", {
         /**
-         * The number of dashes in the line type table record. This value is used for DXF group code 73.
+         * Gets the number of dash elements in the line type pattern.
+         *
+         * This value represents the total count of dashes, spaces, dots, and other pattern elements
+         * that make up the line type. It corresponds to DXF group code 73 in the AutoCAD file format.
+         *
+         * @returns The number of pattern elements in the line type
          */
         get: function () {
             return this._linetype.pattern ? this._linetype.pattern.length : 0;
@@ -48,10 +59,15 @@ var AcDbLinetypeTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLinetypeTableRecord.prototype, "patternLength", {
         /**
-         * The length (in AutoCAD drawing units--the pattern will appear this length when the line type scale is
-         * 1.0) of the pattern in the line type table record. The pattern length is the total length of all
-         * dashes (including pen up spaces). Embedded shapes or text strings do not add to the pattern length
-         * because they are overlaid and do not interrupt the actual dash pattern.
+         * Gets the total pattern length in AutoCAD drawing units.
+         *
+         * The pattern length represents the total length of all dashes and spaces when the line type
+         * scale is 1.0. This value is used to calculate how the pattern repeats along a line.
+         *
+         * Note: Embedded shapes or text strings do not add to the pattern length because they are
+         * overlaid and do not interrupt the actual dash pattern.
+         *
+         * @returns The total length of the line type pattern in drawing units
          */
         get: function () {
             return this._linetype.totalPatternLength;
@@ -61,7 +77,12 @@ var AcDbLinetypeTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLinetypeTableRecord.prototype, "comments", {
         /**
-         * Line type description
+         * Gets the description or comments associated with this line type.
+         *
+         * This property provides additional information about the line type, such as its intended
+         * use or any special characteristics.
+         *
+         * @returns The description text for the line type
          */
         get: function () {
             return this._linetype.description;
@@ -71,7 +92,12 @@ var AcDbLinetypeTableRecord = /** @class */ (function (_super) {
     });
     Object.defineProperty(AcDbLinetypeTableRecord.prototype, "linetype", {
         /**
-         * Line type information used by renderer.
+         * Gets the line type style object used by the renderer.
+         *
+         * This property provides access to the underlying line type definition that contains
+         * all the visual characteristics and rendering information.
+         *
+         * @returns The line type style object
          */
         get: function () {
             return this._linetype;
@@ -80,10 +106,16 @@ var AcDbLinetypeTableRecord = /** @class */ (function (_super) {
         configurable: true
     });
     /**
-     * Get the length (in AutoCAD drawing units--the dash will appear this length when the linetype scale
-     * is 1.0) of the index'th dash in the line type table record.
-     * @param index Input zero-based index. It must be greater than or equal to zero, but less than the
-     * value of property 'numDashes'.
+     * Gets the length of a specific dash element in the line type pattern.
+     *
+     * Each dash element in the pattern has a specific length that determines how it appears
+     * when the line type is rendered. Positive values represent visible dashes, while negative
+     * values represent spaces (pen up).
+     *
+     * @param index - Zero-based index of the dash element. Must be greater than or equal to zero,
+     *                but less than the value of property 'numDashes'
+     * @returns The length of the specified dash element in drawing units
+     * @throws {Error} When the index is out of range
      */
     AcDbLinetypeTableRecord.prototype.dashLengthAt = function (index) {
         if (index < 0 || index >= this.numDashes) {

package/lib/database/AcDbLinetypeTableRecord.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbLinetypeTableRecord.js","sourceRoot":"","sources":["../../src/database/AcDbLinetypeTableRecord.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;;;;;;;;;GAUG;AACH;IAA6C,2CAAqB;IAGhE;;OAEG;IACH,iCAAY,QAA2B;QACrC,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAA;QACzB,KAAI,CAAC,SAAS,GAAG,QAAQ,CAAA;;IAC3B,CAAC;IAKD,sBAAI,8CAAS;QAHb;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QACnE,CAAC;;;OAAA;IAQD,sBAAI,kDAAa;QANjB;;;;;WAKG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAA;QAC1C,CAAC;;;OAAA;IAKD,sBAAI,6CAAQ;QAHZ;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAA;QACnC,CAAC;;;OAAA;IAKD,sBAAI,6CAAQ;QAHZ;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;;;OAAA;IAED;;;;;OAKG;IACH,8CAAY,GAAZ,UAAa,KAAa;QACxB,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CACb,+FAA+F,CAChG,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAQ,CAAC,KAAK,CAAC,CAAC,aAAa,CAAA;IACrD,CAAC;IACH,8BAAC;AAAD,CAAC,AAzDD,CAA6C,qBAAqB,GAyDjE"}
+{"version":3,"file":"AcDbLinetypeTableRecord.js","sourceRoot":"","sources":["../../src/database/AcDbLinetypeTableRecord.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAEA,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;;;;;;;;;;;;GAaG;AACH;IAA6C,2CAAqB;IAGhE;;;;;OAKG;IACH,iCAAY,QAA2B;QACrC,YAAA,MAAK,WAAE,SAAA;QACP,KAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAA;QACzB,KAAI,CAAC,SAAS,GAAG,QAAQ,CAAA;;IAC3B,CAAC;IAUD,sBAAI,8CAAS;QARb;;;;;;;WAOG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAA;QACnE,CAAC;;;OAAA;IAaD,sBAAI,kDAAa;QAXjB;;;;;;;;;;WAUG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAC,kBAAkB,CAAA;QAC1C,CAAC;;;OAAA;IAUD,sBAAI,6CAAQ;QARZ;;;;;;;WAOG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAA;QACnC,CAAC;;;OAAA;IAUD,sBAAI,6CAAQ;QARZ;;;;;;;WAOG;aACH;YACE,OAAO,IAAI,CAAC,SAAS,CAAA;QACvB,CAAC;;;OAAA;IAED;;;;;;;;;;;OAWG;IACH,8CAAY,GAAZ,UAAa,KAAa;QACxB,IAAI,KAAK,GAAG,CAAC,IAAI,KAAK,IAAI,IAAI,CAAC,SAAS,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CACb,+FAA+F,CAChG,CAAA;QACH,CAAC;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,OAAQ,CAAC,KAAK,CAAC,CAAC,aAAa,CAAA;IACrD,CAAC;IACH,8BAAC;AAAD,CAAC,AAtFD,CAA6C,qBAAqB,GAsFjE"}

package/lib/database/AcDbSymbolTable.d.ts

@@ -3,71 +3,176 @@ import { AcDbObjectIterator } from '../misc/AcDbObjectIterator';
 import { AcDbDatabase } from './AcDbDatabase';
 import { AcDbSymbolTableRecord } from './AcDbSymbolTableRecord';
 /**
- * AcDbSymbolTable is the base class for all of the classes used to export AutoCAD's
- * built-in symbol tables.
+ * Base class for all symbol tables in AutoCAD.
+ *
+ * AcDbSymbolTable is the base class for all classes used to manage AutoCAD's
+ * built-in symbol tables. Symbol tables organize and store various types of
+ * records such as layers, linetypes, text styles, dimension styles, etc.
+ *
+ * @template RecordType - The type of records this symbol table manages
+ *
+ * @example
+ * ```typescript
+ * class MySymbolTable extends AcDbSymbolTable<MySymbolTableRecord> {
+ *   constructor(db: AcDbDatabase) {
+ *     super(db);
+ *   }
+ * }
+ * ```
  */
 export declare class AcDbSymbolTable<RecordType extends AcDbSymbolTableRecord = AcDbSymbolTableRecord> extends AcDbObject {
+    /** Map of records indexed by name */
     protected _recordsByName: Map<string, RecordType>;
+    /** Map of records indexed by object ID */
     protected _recordsById: Map<string, RecordType>;
+    /**
+     * Creates a new AcDbSymbolTable instance.
+     *
+     * @param db - The database this symbol table belongs to
+     *
+     * @example
+     * ```typescript
+     * const symbolTable = new AcDbSymbolTable(database);
+     * ```
+     */
     constructor(db: AcDbDatabase);
     /**
-     * Add the record to both the database containing the table and the table itself
-     * @param record Input record to add to the table
+     * Adds a record to both the database containing the table and the table itself.
+     *
+     * @param record - The record to add to the table
+     *
+     * @example
+     * ```typescript
+     * const record = new AcDbSymbolTableRecord({ name: 'MyRecord' });
+     * symbolTable.add(record);
+     * ```
      */
     add(record: RecordType): void;
     /**
-     * Remove the record with the specified name
-     * @param name Input the name of the record to remove
-     * @returns Return true if removing the record correctly. Otherwise, return false.
+     * Removes the record with the specified name.
+     *
+     * @param name - The name of the record to remove
+     * @returns True if the record was found and removed, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const removed = symbolTable.remove('MyRecord');
+     * if (removed) {
+     *   console.log('Record removed successfully');
+     * }
+     * ```
      */
     remove(name: string): boolean;
     /**
-     * Remove the record with the specified id
-     * @param id Input object id of the record to remove
-     * @returns Return true if removing the record correctly. Otherwise, return false.
+     * Removes the record with the specified ID.
+     *
+     * @param id - The object ID of the record to remove
+     * @returns True if the record was found and removed, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const removed = symbolTable.removeId('some-object-id');
+     * if (removed) {
+     *   console.log('Record removed successfully');
+     * }
+     * ```
      */
     removeId(id: AcDbObjectId): boolean;
     /**
-     * Remove all of records in the table.
+     * Removes all records from the table.
+     *
+     * @example
+     * ```typescript
+     * symbolTable.removeAll();
+     * console.log('All records removed');
+     * ```
      */
     removeAll(): void;
     /**
-     * Return true if the table contains a record with the sepcified name. Otherwise it returns false.
+     * Checks if the table contains a record with the specified name.
+     *
+     * @param name - The name to search for
+     * @returns True if a record with the specified name exists, false otherwise
      *
-     * @param name Input name to search for
+     * @example
+     * ```typescript
+     * if (symbolTable.has('MyRecord')) {
+     *   console.log('Record exists');
+     * }
+     * ```
      */
     has(name: string): boolean;
     /**
-     * Return true if the table contains a record with the sepcified id. Otherwise it returns false.
+     * Checks if the table contains a record with the specified ID.
+     *
+     * @param id - The ID to search for
+     * @returns True if a record with the specified ID exists, false otherwise
      *
-     * @param id Input id to search for
+     * @example
+     * ```typescript
+     * if (symbolTable.hasId('some-object-id')) {
+     *   console.log('Record exists');
+     * }
+     * ```
      */
     hasId(id: string): boolean;
     /**
-     * Search the table for the record with the specified name. If found, it return the record.
-     * Otherwise, return undefined.
-     * @param name Input the name to search
-     * @returns If found the record with the specified name, return it. Otherwise, return undefined.
+     * Searches the table for a record with the specified name.
+     *
+     * @param name - The name to search for
+     * @returns The record with the specified name, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const record = symbolTable.getAt('MyRecord');
+     * if (record) {
+     *   console.log('Found record:', record.name);
+     * }
+     * ```
      */
     getAt(name: string): RecordType | undefined;
     /**
-     * Search the table for the record with the specified id. If found, it return the record.
-     * Otherwise, return undefined.
-     * @param id Input the id to search
-     * @returns If found the record with the specified id, return it. Otherwise, return undefined.
+     * Searches the table for a record with the specified ID.
+     *
+     * @param id - The ID to search for
+     * @returns The record with the specified ID, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const record = symbolTable.getIdAt('some-object-id');
+     * if (record) {
+     *   console.log('Found record:', record.name);
+     * }
+     * ```
      */
     getIdAt(id: AcDbObjectId): RecordType | undefined;
     /**
-     * Search the table for the record with the specified owner id. If found, it return the record.
-     * Otherwise, return undefined.
-     * @param id Input the owner id to search
-     * @returns If found the record with the specified owner id, return it. Otherwise, return undefined.
+     * Gets the owner ID of a record with the specified ID.
+     *
+     * @param id - The ID to search for
+     * @returns The record with the specified ID, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const record = symbolTable.getOwnerIdAt('some-object-id');
+     * if (record) {
+     *   console.log('Owner ID:', record.ownerId);
+     * }
+     * ```
      */
     getOwnerIdAt(id: AcDbObjectId): RecordType | undefined;
     /**
-     * Create an iterator object that can be used to iterate through the contents of the symbol table.
+     * Creates an iterator object that can be used to iterate over the records in the table.
+     *
+     * @returns An iterator object that can be used to iterate over the records
      *
-     * @returns Return an iterator object that can be used to iterate through the contents of the symbol table.
+     * @example
+     * ```typescript
+     * const iterator = symbolTable.newIterator();
+     * for (const record of iterator) {
+     *   console.log('Record:', record.name);
+     * }
+     * ```
      */
     newIterator(): AcDbObjectIterator<RecordType>;
 }

package/lib/database/AcDbSymbolTable.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbSymbolTable.d.ts","sourceRoot":"","sources":["../../src/database/AcDbSymbolTable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;;GAGG;AACH,qBAAa,eAAe,CAC1B,UAAU,SAAS,qBAAqB,GAAG,qBAAqB,CAChE,SAAQ,UAAU;IAClB,SAAS,CAAC,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACjD,SAAS,CAAC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;gBAEnC,EAAE,EAAE,YAAY;IAO5B;;;OAGG;IACH,GAAG,CAAC,MAAM,EAAE,UAAU;IAMtB;;;;OAIG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM;IAUnB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,EAAE,YAAY;IAUzB;;OAEG;IACH,SAAS;IAKT;;;;OAIG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM;IAIhB;;;;OAIG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM;IAIhB;;;;;OAKG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM;IAIlB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,EAAE,YAAY;IAIxB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,EAAE,YAAY,GAAG,UAAU,GAAG,SAAS;IAUtD;;;;OAIG;IACH,WAAW,IAAI,kBAAkB,CAAC,UAAU,CAAC;CAG9C"}
+{"version":3,"file":"AcDbSymbolTable.d.ts","sourceRoot":"","sources":["../../src/database/AcDbSymbolTable.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAA;AAC7D,OAAO,EAAE,kBAAkB,EAAE,MAAM,4BAA4B,CAAA;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAA;AAC7C,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAE/D;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,eAAe,CAC1B,UAAU,SAAS,qBAAqB,GAAG,qBAAqB,CAChE,SAAQ,UAAU;IAClB,qCAAqC;IACrC,SAAS,CAAC,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IACjD,0CAA0C;IAC1C,SAAS,CAAC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,UAAU,CAAC,CAAA;IAE/C;;;;;;;;;OASG;gBACS,EAAE,EAAE,YAAY;IAO5B;;;;;;;;;;OAUG;IACH,GAAG,CAAC,MAAM,EAAE,UAAU;IAMtB;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM;IAUnB;;;;;;;;;;;;;OAaG;IACH,QAAQ,CAAC,EAAE,EAAE,YAAY;IAUzB;;;;;;;;OAQG;IACH,SAAS;IAKT;;;;;;;;;;;;OAYG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM;IAIhB;;;;;;;;;;;;OAYG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM;IAIhB;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM;IAIlB;;;;;;;;;;;;;OAaG;IACH,OAAO,CAAC,EAAE,EAAE,YAAY;IAIxB;;;;;;;;;;;;;OAaG;IACH,YAAY,CAAC,EAAE,EAAE,YAAY,GAAG,UAAU,GAAG,SAAS;IAItD;;;;;;;;;;;;OAYG;IACH,WAAW,IAAI,kBAAkB,CAAC,UAAU,CAAC;CAG9C"}