@mlightcad/data-model 1.1.2 → 1.1.4

package/lib/misc/AcDbUnitsValue.d.ts

@@ -1,51 +1,101 @@
 /**
- * Linear unit
+ * Enumeration of linear units used in AutoCAD drawings.
+ *
+ * This enum defines the various units that can be used to represent
+ * linear measurements in AutoCAD drawings, including metric, imperial,
+ * and survey units.
  */
 export declare enum AcDbUnitsValue {
+    /** Undefined or unitless */
     Undefined = 0,
+    /** Inches */
     Inches = 1,
+    /** Feet */
     Feet = 2,
+    /** Miles */
     Miles = 3,
+    /** Millimeters */
     Millimeters = 4,
+    /** Centimeters */
     Centimeters = 5,
+    /** Meters */
     Meters = 6,
+    /** Kilometers */
     Kilometers = 7,
+    /** Microinches */
     Microinches = 8,
+    /** Mils (thousandths of an inch) */
     Mils = 9,
+    /** Yards */
     Yards = 10,
+    /** Angstroms */
     Angstroms = 11,
+    /** Nanometers */
     Nanometers = 12,
+    /** Microns (micrometers) */
     Microns = 13,
+    /** Decimeters */
     Decimeters = 14,
+    /** Dekameters */
     Dekameters = 15,
+    /** Hectometers */
     Hectometers = 16,
+    /** Gigameters */
     Gigameters = 17,
+    /** Astronomical units */
     Astronomical = 18,
+    /** Light years */
     LightYears = 19,
+    /** Parsecs */
     Parsecs = 20,
     /**
-     * Note: US Survey Feet is a historical survey unit that's about 2 parts per million larger than
+     * US Survey Feet - a historical survey unit that's about 2 parts per million larger than
      * the International Feet unit. This difference is significant only at scales used for mapping in
      * the U.S. The US Survey Feet setting is supported only for inserting or attaching drawings
      * starting with AutoCAD 2017-based products. Drawings opened in prior versions will treat the US
      * Survey Feet setting as Unitless.
      */
     USSurveyFeet = 21,
+    /** US Survey Inches */
     USSurveyInch = 22,
+    /** US Survey Yards */
     USSurveyYard = 23,
+    /** US Survey Miles */
     USSurveyMile = 24,
+    /** Maximum value for units */
     Max = 24
 }
 /**
- * Return true if the specified units value is metric units.
- * @param units Input units to check
- * @returns Return true if the specified units value is metric units.
+ * Checks if the specified units value represents metric units.
+ *
+ * This function returns true if the units are part of the metric system,
+ * including millimeters, centimeters, meters, kilometers, and their
+ * decimal multiples and submultiples.
+ *
+ * @param units - The units value to check
+ * @returns True if the units are metric, false otherwise
+ *
+ * @example
+ * ```typescript
+ * const isMetric = isMetricUnits(AcDbUnitsValue.Millimeters); // true
+ * const isMetric2 = isMetricUnits(AcDbUnitsValue.Inches); // false
+ * ```
  */
 export declare function isMetricUnits(units: AcDbUnitsValue): units is AcDbUnitsValue.Millimeters | AcDbUnitsValue.Centimeters | AcDbUnitsValue.Meters | AcDbUnitsValue.Kilometers | AcDbUnitsValue.Nanometers | AcDbUnitsValue.Microns | AcDbUnitsValue.Decimeters | AcDbUnitsValue.Dekameters | AcDbUnitsValue.Hectometers | AcDbUnitsValue.Gigameters;
 /**
- * Return true if the specified units value is imperial units.
- * @param units Input units to check
- * @returns Return true if the specified units value is imperial units.
+ * Checks if the specified units value represents imperial units.
+ *
+ * This function returns true if the units are part of the imperial system,
+ * including inches, feet, miles, yards, and US survey units.
+ *
+ * @param units - The units value to check
+ * @returns True if the units are imperial, false otherwise
+ *
+ * @example
+ * ```typescript
+ * const isImperial = isImperialUnits(AcDbUnitsValue.Inches); // true
+ * const isImperial2 = isImperialUnits(AcDbUnitsValue.Millimeters); // false
+ * ```
  */
 export declare function isImperialUnits(units: AcDbUnitsValue): units is AcDbUnitsValue.Inches | AcDbUnitsValue.Feet | AcDbUnitsValue.Miles | AcDbUnitsValue.Microinches | AcDbUnitsValue.Mils | AcDbUnitsValue.Yards | AcDbUnitsValue.USSurveyFeet;
 //# sourceMappingURL=AcDbUnitsValue.d.ts.map

package/lib/misc/AcDbUnitsValue.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbUnitsValue.d.ts","sourceRoot":"","sources":["../../src/misc/AcDbUnitsValue.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,oBAAY,cAAc;IACxB,SAAS,IAAI;IACb,MAAM,IAAI;IACV,IAAI,IAAI;IACR,KAAK,IAAI;IACT,WAAW,IAAI;IACf,WAAW,IAAI;IACf,MAAM,IAAI;IACV,UAAU,IAAI;IACd,WAAW,IAAI;IACf,IAAI,IAAI;IACR,KAAK,KAAK;IACV,SAAS,KAAK;IACd,UAAU,KAAK;IACf,OAAO,KAAK;IACZ,UAAU,KAAK;IACf,UAAU,KAAK;IACf,WAAW,KAAK;IAChB,UAAU,KAAK;IACf,YAAY,KAAK;IACjB,UAAU,KAAK;IACf,OAAO,KAAK;IACZ;;;;;;OAMG;IACH,YAAY,KAAK;IACjB,YAAY,KAAK;IACjB,YAAY,KAAK;IACjB,YAAY,KAAK;IACjB,GAAG,KAAe;CACnB;AAED;;;;GAIG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,cAAc,8RAalD;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,cAAc,uLAUpD"}
+{"version":3,"file":"AcDbUnitsValue.d.ts","sourceRoot":"","sources":["../../src/misc/AcDbUnitsValue.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,oBAAY,cAAc;IACxB,4BAA4B;IAC5B,SAAS,IAAI;IACb,aAAa;IACb,MAAM,IAAI;IACV,WAAW;IACX,IAAI,IAAI;IACR,YAAY;IACZ,KAAK,IAAI;IACT,kBAAkB;IAClB,WAAW,IAAI;IACf,kBAAkB;IAClB,WAAW,IAAI;IACf,aAAa;IACb,MAAM,IAAI;IACV,iBAAiB;IACjB,UAAU,IAAI;IACd,kBAAkB;IAClB,WAAW,IAAI;IACf,oCAAoC;IACpC,IAAI,IAAI;IACR,YAAY;IACZ,KAAK,KAAK;IACV,gBAAgB;IAChB,SAAS,KAAK;IACd,iBAAiB;IACjB,UAAU,KAAK;IACf,4BAA4B;IAC5B,OAAO,KAAK;IACZ,iBAAiB;IACjB,UAAU,KAAK;IACf,iBAAiB;IACjB,UAAU,KAAK;IACf,kBAAkB;IAClB,WAAW,KAAK;IAChB,iBAAiB;IACjB,UAAU,KAAK;IACf,yBAAyB;IACzB,YAAY,KAAK;IACjB,kBAAkB;IAClB,UAAU,KAAK;IACf,cAAc;IACd,OAAO,KAAK;IACZ;;;;;;OAMG;IACH,YAAY,KAAK;IACjB,uBAAuB;IACvB,YAAY,KAAK;IACjB,sBAAsB;IACtB,YAAY,KAAK;IACjB,sBAAsB;IACtB,YAAY,KAAK;IACjB,8BAA8B;IAC9B,GAAG,KAAe;CACnB;AAED;;;;;;;;;;;;;;;GAeG;AACH,wBAAgB,aAAa,CAAC,KAAK,EAAE,cAAc,8RAalD;AAED;;;;;;;;;;;;;;GAcG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,cAAc,uLAUpD"}

package/lib/misc/AcDbUnitsValue.js

@@ -1,46 +1,86 @@
 /**
- * Linear unit
+ * Enumeration of linear units used in AutoCAD drawings.
+ *
+ * This enum defines the various units that can be used to represent
+ * linear measurements in AutoCAD drawings, including metric, imperial,
+ * and survey units.
  */
 export var AcDbUnitsValue;
 (function (AcDbUnitsValue) {
+    /** Undefined or unitless */
     AcDbUnitsValue[AcDbUnitsValue["Undefined"] = 0] = "Undefined";
+    /** Inches */
     AcDbUnitsValue[AcDbUnitsValue["Inches"] = 1] = "Inches";
+    /** Feet */
     AcDbUnitsValue[AcDbUnitsValue["Feet"] = 2] = "Feet";
+    /** Miles */
     AcDbUnitsValue[AcDbUnitsValue["Miles"] = 3] = "Miles";
+    /** Millimeters */
     AcDbUnitsValue[AcDbUnitsValue["Millimeters"] = 4] = "Millimeters";
+    /** Centimeters */
     AcDbUnitsValue[AcDbUnitsValue["Centimeters"] = 5] = "Centimeters";
+    /** Meters */
     AcDbUnitsValue[AcDbUnitsValue["Meters"] = 6] = "Meters";
+    /** Kilometers */
     AcDbUnitsValue[AcDbUnitsValue["Kilometers"] = 7] = "Kilometers";
+    /** Microinches */
     AcDbUnitsValue[AcDbUnitsValue["Microinches"] = 8] = "Microinches";
+    /** Mils (thousandths of an inch) */
     AcDbUnitsValue[AcDbUnitsValue["Mils"] = 9] = "Mils";
+    /** Yards */
     AcDbUnitsValue[AcDbUnitsValue["Yards"] = 10] = "Yards";
+    /** Angstroms */
     AcDbUnitsValue[AcDbUnitsValue["Angstroms"] = 11] = "Angstroms";
+    /** Nanometers */
     AcDbUnitsValue[AcDbUnitsValue["Nanometers"] = 12] = "Nanometers";
+    /** Microns (micrometers) */
     AcDbUnitsValue[AcDbUnitsValue["Microns"] = 13] = "Microns";
+    /** Decimeters */
     AcDbUnitsValue[AcDbUnitsValue["Decimeters"] = 14] = "Decimeters";
+    /** Dekameters */
     AcDbUnitsValue[AcDbUnitsValue["Dekameters"] = 15] = "Dekameters";
+    /** Hectometers */
     AcDbUnitsValue[AcDbUnitsValue["Hectometers"] = 16] = "Hectometers";
+    /** Gigameters */
     AcDbUnitsValue[AcDbUnitsValue["Gigameters"] = 17] = "Gigameters";
+    /** Astronomical units */
     AcDbUnitsValue[AcDbUnitsValue["Astronomical"] = 18] = "Astronomical";
+    /** Light years */
     AcDbUnitsValue[AcDbUnitsValue["LightYears"] = 19] = "LightYears";
+    /** Parsecs */
     AcDbUnitsValue[AcDbUnitsValue["Parsecs"] = 20] = "Parsecs";
     /**
-     * Note: US Survey Feet is a historical survey unit that's about 2 parts per million larger than
+     * US Survey Feet - a historical survey unit that's about 2 parts per million larger than
      * the International Feet unit. This difference is significant only at scales used for mapping in
      * the U.S. The US Survey Feet setting is supported only for inserting or attaching drawings
      * starting with AutoCAD 2017-based products. Drawings opened in prior versions will treat the US
      * Survey Feet setting as Unitless.
      */
     AcDbUnitsValue[AcDbUnitsValue["USSurveyFeet"] = 21] = "USSurveyFeet";
+    /** US Survey Inches */
     AcDbUnitsValue[AcDbUnitsValue["USSurveyInch"] = 22] = "USSurveyInch";
+    /** US Survey Yards */
     AcDbUnitsValue[AcDbUnitsValue["USSurveyYard"] = 23] = "USSurveyYard";
+    /** US Survey Miles */
     AcDbUnitsValue[AcDbUnitsValue["USSurveyMile"] = 24] = "USSurveyMile";
+    /** Maximum value for units */
     AcDbUnitsValue[AcDbUnitsValue["Max"] = 24] = "Max";
 })(AcDbUnitsValue || (AcDbUnitsValue = {}));
 /**
- * Return true if the specified units value is metric units.
- * @param units Input units to check
- * @returns Return true if the specified units value is metric units.
+ * Checks if the specified units value represents metric units.
+ *
+ * This function returns true if the units are part of the metric system,
+ * including millimeters, centimeters, meters, kilometers, and their
+ * decimal multiples and submultiples.
+ *
+ * @param units - The units value to check
+ * @returns True if the units are metric, false otherwise
+ *
+ * @example
+ * ```typescript
+ * const isMetric = isMetricUnits(AcDbUnitsValue.Millimeters); // true
+ * const isMetric2 = isMetricUnits(AcDbUnitsValue.Inches); // false
+ * ```
  */
 export function isMetricUnits(units) {
     return (units == AcDbUnitsValue.Millimeters ||
@@ -55,9 +95,19 @@ export function isMetricUnits(units) {
         units == AcDbUnitsValue.Gigameters);
 }
 /**
- * Return true if the specified units value is imperial units.
- * @param units Input units to check
- * @returns Return true if the specified units value is imperial units.
+ * Checks if the specified units value represents imperial units.
+ *
+ * This function returns true if the units are part of the imperial system,
+ * including inches, feet, miles, yards, and US survey units.
+ *
+ * @param units - The units value to check
+ * @returns True if the units are imperial, false otherwise
+ *
+ * @example
+ * ```typescript
+ * const isImperial = isImperialUnits(AcDbUnitsValue.Inches); // true
+ * const isImperial2 = isImperialUnits(AcDbUnitsValue.Millimeters); // false
+ * ```
  */
 export function isImperialUnits(units) {
     return (units == AcDbUnitsValue.Inches ||

package/lib/misc/AcDbUnitsValue.js.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbUnitsValue.js","sourceRoot":"","sources":["../../src/misc/AcDbUnitsValue.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,CAAN,IAAY,cAkCX;AAlCD,WAAY,cAAc;IACxB,6DAAa,CAAA;IACb,uDAAU,CAAA;IACV,mDAAQ,CAAA;IACR,qDAAS,CAAA;IACT,iEAAe,CAAA;IACf,iEAAe,CAAA;IACf,uDAAU,CAAA;IACV,+DAAc,CAAA;IACd,iEAAe,CAAA;IACf,mDAAQ,CAAA;IACR,sDAAU,CAAA;IACV,8DAAc,CAAA;IACd,gEAAe,CAAA;IACf,0DAAY,CAAA;IACZ,gEAAe,CAAA;IACf,gEAAe,CAAA;IACf,kEAAgB,CAAA;IAChB,gEAAe,CAAA;IACf,oEAAiB,CAAA;IACjB,gEAAe,CAAA;IACf,0DAAY,CAAA;IACZ;;;;;;OAMG;IACH,oEAAiB,CAAA;IACjB,oEAAiB,CAAA;IACjB,oEAAiB,CAAA;IACjB,oEAAiB,CAAA;IACjB,kDAAkB,CAAA;AACpB,CAAC,EAlCW,cAAc,KAAd,cAAc,QAkCzB;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAqB;IACjD,OAAO,CACL,KAAK,IAAI,cAAc,CAAC,WAAW;QACnC,KAAK,IAAI,cAAc,CAAC,WAAW;QACnC,KAAK,IAAI,cAAc,CAAC,MAAM;QAC9B,KAAK,IAAI,cAAc,CAAC,UAAU;QAClC,KAAK,IAAI,cAAc,CAAC,UAAU;QAClC,KAAK,IAAI,cAAc,CAAC,OAAO;QAC/B,KAAK,IAAI,cAAc,CAAC,UAAU;QAClC,KAAK,IAAI,cAAc,CAAC,UAAU;QAClC,KAAK,IAAI,cAAc,CAAC,WAAW;QACnC,KAAK,IAAI,cAAc,CAAC,UAAU,CACnC,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,eAAe,CAAC,KAAqB;IACnD,OAAO,CACL,KAAK,IAAI,cAAc,CAAC,MAAM;QAC9B,KAAK,IAAI,cAAc,CAAC,IAAI;QAC5B,KAAK,IAAI,cAAc,CAAC,KAAK;QAC7B,KAAK,IAAI,cAAc,CAAC,WAAW;QACnC,KAAK,IAAI,cAAc,CAAC,IAAI;QAC5B,KAAK,IAAI,cAAc,CAAC,KAAK;QAC7B,KAAK,IAAI,cAAc,CAAC,YAAY,CACrC,CAAA;AACH,CAAC"}
+{"version":3,"file":"AcDbUnitsValue.js","sourceRoot":"","sources":["../../src/misc/AcDbUnitsValue.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AACH,MAAM,CAAN,IAAY,cA2DX;AA3DD,WAAY,cAAc;IACxB,4BAA4B;IAC5B,6DAAa,CAAA;IACb,aAAa;IACb,uDAAU,CAAA;IACV,WAAW;IACX,mDAAQ,CAAA;IACR,YAAY;IACZ,qDAAS,CAAA;IACT,kBAAkB;IAClB,iEAAe,CAAA;IACf,kBAAkB;IAClB,iEAAe,CAAA;IACf,aAAa;IACb,uDAAU,CAAA;IACV,iBAAiB;IACjB,+DAAc,CAAA;IACd,kBAAkB;IAClB,iEAAe,CAAA;IACf,oCAAoC;IACpC,mDAAQ,CAAA;IACR,YAAY;IACZ,sDAAU,CAAA;IACV,gBAAgB;IAChB,8DAAc,CAAA;IACd,iBAAiB;IACjB,gEAAe,CAAA;IACf,4BAA4B;IAC5B,0DAAY,CAAA;IACZ,iBAAiB;IACjB,gEAAe,CAAA;IACf,iBAAiB;IACjB,gEAAe,CAAA;IACf,kBAAkB;IAClB,kEAAgB,CAAA;IAChB,iBAAiB;IACjB,gEAAe,CAAA;IACf,yBAAyB;IACzB,oEAAiB,CAAA;IACjB,kBAAkB;IAClB,gEAAe,CAAA;IACf,cAAc;IACd,0DAAY,CAAA;IACZ;;;;;;OAMG;IACH,oEAAiB,CAAA;IACjB,uBAAuB;IACvB,oEAAiB,CAAA;IACjB,sBAAsB;IACtB,oEAAiB,CAAA;IACjB,sBAAsB;IACtB,oEAAiB,CAAA;IACjB,8BAA8B;IAC9B,kDAAkB,CAAA;AACpB,CAAC,EA3DW,cAAc,KAAd,cAAc,QA2DzB;AAED;;;;;;;;;;;;;;;GAeG;AACH,MAAM,UAAU,aAAa,CAAC,KAAqB;IACjD,OAAO,CACL,KAAK,IAAI,cAAc,CAAC,WAAW;QACnC,KAAK,IAAI,cAAc,CAAC,WAAW;QACnC,KAAK,IAAI,cAAc,CAAC,MAAM;QAC9B,KAAK,IAAI,cAAc,CAAC,UAAU;QAClC,KAAK,IAAI,cAAc,CAAC,UAAU;QAClC,KAAK,IAAI,cAAc,CAAC,OAAO;QAC/B,KAAK,IAAI,cAAc,CAAC,UAAU;QAClC,KAAK,IAAI,cAAc,CAAC,UAAU;QAClC,KAAK,IAAI,cAAc,CAAC,WAAW;QACnC,KAAK,IAAI,cAAc,CAAC,UAAU,CACnC,CAAA;AACH,CAAC;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,UAAU,eAAe,CAAC,KAAqB;IACnD,OAAO,CACL,KAAK,IAAI,cAAc,CAAC,MAAM;QAC9B,KAAK,IAAI,cAAc,CAAC,IAAI;QAC5B,KAAK,IAAI,cAAc,CAAC,KAAK;QAC7B,KAAK,IAAI,cAAc,CAAC,WAAW;QACnC,KAAK,IAAI,cAAc,CAAC,IAAI;QAC5B,KAAK,IAAI,cAAc,CAAC,KAAK;QAC7B,KAAK,IAAI,cAAc,CAAC,YAAY,CACrC,CAAA;AACH,CAAC"}

package/lib/object/AcDbDictionary.d.ts

@@ -2,78 +2,176 @@ import { AcDbObject, AcDbObjectId } from '../base';
 import { AcDbDatabase } from '../database';
 import { AcDbObjectIterator } from '../misc';
 /**
- * A database-resident object dictionary, which maintains a map between text strings and database objects.
+ * A database-resident object dictionary that maintains a map between text strings and database objects.
+ *
  * An instance of this class represents a single object, such as Drawing Symbol Table, to which objects
  * derived from AcDbObject may be added, accessed, and removed. Entries in an AcDbDictionary must be unique.
  * Entries consist of a unique AcDbObject and string, which comprises the entry's key name. The key may be
- * either an text string, or an asterisk ('*') as the first character in the string to signify an anonymous
+ * either a text string, or an asterisk ('*') as the first character in the string to signify an anonymous
  * entry. An anonymous entry's key will be constructed internally by appending an 'A' plus a unique integer
  * value to the asterisk; for example, '*A13'. When an object is placed in a dictionary, the dictionary is
  * established as the object's owner, the lookup key string is associated with the object's object ID, and
  * the dictionary itself is attached to the object as a persistent reactor so that the dictionary is notified
  * when the object is erased.
+ *
+ * @template TObjectType - The type of objects stored in this dictionary
+ *
+ * @example
+ * ```typescript
+ * const dictionary = new AcDbDictionary<AcDbLayout>(database);
+ * const layout = new AcDbLayout();
+ * dictionary.setAt('MyLayout', layout);
+ * const retrievedLayout = dictionary.getAt('MyLayout');
+ * ```
  */
 export declare class AcDbDictionary<TObjectType extends AcDbObject = AcDbObject> extends AcDbObject {
+    /** Map of records indexed by name */
     protected _recordsByName: Map<string, TObjectType>;
+    /** Map of records indexed by object ID */
     protected _recordsById: Map<string, TObjectType>;
+    /**
+     * Creates a new AcDbDictionary instance.
+     *
+     * @param db - The database this dictionary belongs to
+     *
+     * @example
+     * ```typescript
+     * const dictionary = new AcDbDictionary(database);
+     * ```
+     */
     constructor(db: AcDbDatabase);
     /**
-     * The number of entries in the dictionary.
+     * Gets the number of entries in the dictionary.
+     *
+     * @returns The number of entries in the dictionary
+     *
+     * @example
+     * ```typescript
+     * const count = dictionary.numEntries;
+     * console.log(`Dictionary has ${count} entries`);
+     * ```
      */
     get numEntries(): number;
     /**
-     * Add a new entry specified by 'value' into the dictionary, if 'key' does not already exist in the
-     * dictionary. If the entry with 'key' already exists, the existing entry is erased.
-     * @param key Input string representing the object's search key name
-     * @param value Input the new object to add to the dictionary
+     * Adds a new entry to the dictionary.
+     *
+     * If an entry with the specified key already exists, the existing entry is erased
+     * and replaced with the new one.
+     *
+     * @param key - String representing the object's search key name
+     * @param value - The new object to add to the dictionary
+     *
+     * @example
+     * ```typescript
+     * const layout = new AcDbLayout();
+     * dictionary.setAt('MyLayout', layout);
+     * ```
      */
     setAt(key: string, value: TObjectType): void;
     /**
-     * Remove the entry specified by 'name' from the dictionary.
-     * @param name Input string representing the entry's key (or name)
-     * @returns If the entry specified by object id exists in the dictionary and remove it correctly, return
-     * true. Otherwise, return false.
+     * Removes the entry specified by name from the dictionary.
+     *
+     * @param name - String representing the entry's key (or name)
+     * @returns True if the entry was found and removed, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const removed = dictionary.remove('MyLayout');
+     * if (removed) {
+     *   console.log('Layout removed successfully');
+     * }
+     * ```
      */
     remove(name: string): boolean;
     /**
-     * Remove the entry specified by object id from the dictionary.
-     * @param id Input id of the object to delete
-     * @returns If the entry specified by object id exists in the dictionary and remove it correctly, return
-     * true. Otherwise, return false.
+     * Removes the entry specified by object ID from the dictionary.
+     *
+     * @param id - ID of the object to delete
+     * @returns True if the entry was found and removed, false otherwise
+     *
+     * @example
+     * ```typescript
+     * const removed = dictionary.removeId('some-object-id');
+     * ```
      */
     removeId(id: string): boolean;
     /**
-     * Remove all of records in the dictionary.
+     * Removes all records from the dictionary.
+     *
+     * @example
+     * ```typescript
+     * dictionary.removeAll();
+     * ```
      */
     removeAll(): void;
     /**
-     * Return true if the dictionary contains an object with the sepcified name. Otherwise it returns false.
-     * @param name Input name to search for
+     * Checks if the dictionary contains an object with the specified name.
+     *
+     * @param name - Name to search for
+     * @returns True if the dictionary contains an object with the specified name, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (dictionary.has('MyLayout')) {
+     *   console.log('Layout exists');
+     * }
+     * ```
      */
     has(name: string): boolean;
     /**
-     * Return true if the dictionary contains an object with the sepcified id. Otherwise it returns false.
-     * @param id Input object id to search for
+     * Checks if the dictionary contains an object with the specified ID.
+     *
+     * @param id - ID to search for
+     * @returns True if the dictionary contains an object with the specified ID, false otherwise
+     *
+     * @example
+     * ```typescript
+     * if (dictionary.hasId('some-object-id')) {
+     *   console.log('Object exists');
+     * }
+     * ```
      */
     hasId(id: string): boolean;
     /**
-     * Search the dictionary for the object with the specified name. If found, it return the record.
-     * Otherwise, return undefined.
-     * @param name Input the name to search
-     * @returns If found the object with the specified name, return it. Otherwise, return undefined.
+     * Gets the object with the specified name from the dictionary.
+     *
+     * @param name - Name of the object to retrieve
+     * @returns The object with the specified name, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const layout = dictionary.getAt('MyLayout');
+     * if (layout) {
+     *   console.log('Layout found:', layout);
+     * }
+     * ```
      */
     getAt(name: string): TObjectType | undefined;
     /**
-     * Search the dictionary for the record with the specified id. If found, it returns the record.
-     * Otherwise, return undefined.
-     * @param id Input the id to search
-     * @returns If found the object with the specified id, return it. Otherwise, return undefined.
+     * Gets the object with the specified ID from the dictionary.
+     *
+     * @param id - ID of the object to retrieve
+     * @returns The object with the specified ID, or undefined if not found
+     *
+     * @example
+     * ```typescript
+     * const object = dictionary.getIdAt('some-object-id');
+     * ```
      */
     getIdAt(id: AcDbObjectId): TObjectType | undefined;
     /**
-     * Create an iterator object that can be used to iterate through the contents of the symbol table.
+     * Creates a new iterator for traversing the dictionary entries.
+     *
+     * @returns A new AcDbObjectIterator for this dictionary
      *
-     * @returns Return an iterator object that can be used to iterate through the contents of the symbol table.
+     * @example
+     * ```typescript
+     * const iterator = dictionary.newIterator();
+     * while (iterator.hasNext()) {
+     *   const object = iterator.next();
+     *   console.log('Object:', object);
+     * }
+     * ```
      */
     newIterator(): AcDbObjectIterator<TObjectType>;
 }

package/lib/object/AcDbDictionary.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"AcDbDictionary.d.ts","sourceRoot":"","sources":["../../src/object/AcDbDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAE5C;;;;;;;;;;;GAWG;AACH,qBAAa,cAAc,CACzB,WAAW,SAAS,UAAU,GAAG,UAAU,CAC3C,SAAQ,UAAU;IAClB,SAAS,CAAC,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAClD,SAAS,CAAC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;gBAEpC,EAAE,EAAE,YAAY;IAO5B;;OAEG;IACH,IAAI,UAAU,WAEb;IAED;;;;;OAKG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW;IAMrC;;;;;OAKG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM;IAUnB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM;IAYnB;;OAEG;IACH,SAAS;IAKT;;;OAGG;IACH,GAAG,CAAC,IAAI,EAAE,MAAM;IAIhB;;;OAGG;IACH,KAAK,CAAC,EAAE,EAAE,MAAM;IAIhB;;;;;OAKG;IACH,KAAK,CAAC,IAAI,EAAE,MAAM;IAIlB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,EAAE,YAAY;IAIxB;;;;OAIG;IACH,WAAW,IAAI,kBAAkB,CAAC,WAAW,CAAC;CAG/C"}
+{"version":3,"file":"AcDbDictionary.d.ts","sourceRoot":"","sources":["../../src/object/AcDbDictionary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAA;AAClD,OAAO,EAAE,YAAY,EAAE,MAAM,aAAa,CAAA;AAC1C,OAAO,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAA;AAE5C;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,qBAAa,cAAc,CACzB,WAAW,SAAS,UAAU,GAAG,UAAU,CAC3C,SAAQ,UAAU;IAClB,qCAAqC;IACrC,SAAS,CAAC,cAAc,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAClD,0CAA0C;IAC1C,SAAS,CAAC,YAAY,EAAE,GAAG,CAAC,MAAM,EAAE,WAAW,CAAC,CAAA;IAEhD;;;;;;;;;OASG;gBACS,EAAE,EAAE,YAAY;IAO5B;;;;;;;;;;OAUG;IACH,IAAI,UAAU,WAEb;IAED;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW;IAMrC;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAAI,EAAE,MAAM;IAUnB;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM;IAYnB;;;;;;;OAOG;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;;;;;;;;;;OAUG;IACH,OAAO,CAAC,EAAE,EAAE,YAAY;IAIxB;;;;;;;;;;;;;OAaG;IACH,WAAW,IAAI,kBAAkB,CAAC,WAAW,CAAC;CAG/C"}