@ygracs/xobj-lib-js 0.2.4 → 0.2.6-b

package/CHANGELOG.md

@@ -1,3 +1,11 @@
+#### *v0.2.x*
+
+Release version.
+
+> - update `xObj.md`;
+> - add a new `EvalKeyNameError` class;
+> - some fixes.
+
 #### *v0.2.4*
 
 Release version.

package/doc/xObj.md

@@ -1,6 +1,6 @@
->|***rev.*:**|0.1.45|
+>|***rev.*:**|0.1.46|
 >|:---|---:|
->|date:|2025-07-19|
+>|date:|2025-12-14|
 
 ## Introduction
 
@@ -36,6 +36,58 @@ The behavior for `letterCase` settings defined in the table below:
 | `lower` | the resulting string must to be present in lower case |
 | any other values | the resulting string will be not transformed |
 
+<a name="typedef+xml2jsParseOptions"></a>
+#### `xml2jsParseOptions` - parser options set
+
+This options set is an `object` which defines how an 'XML'-string transforms into a 'JS'-object.
+
+| option name | value type | optional | description |
+|:---|---|---:|:---|
+| `compact` | `boolean` | `yes` ||
+| `declarationKey` | `string` | `yes` ||
+| `attributesKey` | `string` | `yes` ||
+| `textKey` | `string` | `yes` ||
+| `commentKey` | `string` | `yes` ||
+| `cdataKey` | `string` | `yes` ||
+| `nameKey` | `string` | `yes` ||
+| `typeKey` | `string` | `yes` ||
+| `parentKey` | `string` | `yes` ||
+| `elementsKey` | `string` | `yes` ||
+| `ignoreDeclaration` | `boolean` | `yes` ||
+| `ignoreDocType` | `boolean` | `yes` ||
+| `ignoreInstraction` | `boolean` | `yes` ||
+| `ignoreText` | `boolean` | `yes` ||
+| `ignoreComment` | `boolean` | `yes` ||
+| `ignoreCData` | `boolean` | `yes` ||
+| `addParent` | `boolean` | `yes` ||
+| `trim` | `boolean` | `yes` ||
+
+<a name="typedef+js2xmlParseOptions"></a>
+#### `js2xmlParseOptions` - parser options set
+
+This options set is an `object` which defines how a 'JS'-object transforms into an 'XML'-string.
+
+| option name | value type | optional | description |
+|:---|---|---:|:---|
+| `compact` | `boolean` | `yes` ||
+| `declarationKey` | `string` | `yes` ||
+| `attributesKey` | `string` | `yes` ||
+| `textKey` | `string` | `yes` ||
+| `commentKey` | `string` | `yes` ||
+| `cdataKey` | `string` | `yes` ||
+| `nameKey` | `string` | `yes` ||
+| `typeKey` | `string` | `yes` ||
+| `parentKey` | `string` | `yes` ||
+| `elementsKey` | `string` | `yes` ||
+| `ignoreDeclaration` | `boolean` | `yes` ||
+| `ignoreDocType` | `boolean` | `yes` ||
+| `ignoreInstraction` | `boolean` | `yes` ||
+| `ignoreText` | `boolean` | `yes` ||
+| `ignoreComment` | `boolean` | `yes` ||
+| `ignoreCData` | `boolean` | `yes` ||
+| `fullTagEmptyElement` | `boolean` | `yes` ||
+| `spaces` | `number` | `yes` ||
+
 ### Base constants
 
 |name|type|value|
@@ -50,28 +102,30 @@ This constant object provided by the module contains a default settings of optio
 
 The settings listed in the table below:
 
-|name|type|value|
-|:---|---|:---|
-|compact|`boolean`|`true`|
-|declarationKey|`string`|`__decl`|
-|attributesKey|`string`|`__attr`|
-|textKey|`string`|`__text`|
-|commentKey|`string`|`__note`|
-|cdataKey|`string`|`__cdata`|
-|nameKey|`string`|`__name`|
-|typeKey|`string`|`__type`|
-|parentKey|`string`|`parent`|
-|elementsKey|`string`|`items`|
-|ignoreDeclaration|`boolean`|`false`|
-|ignoreDocType|`boolean`|`false`|
-|ignoreInstractions|`boolean`|`false`|
-|ignoreText|`boolean`|`false`|
-|ignoreComments|`boolean`|`false`|
-|ignoreCData|`boolean`|`false`|
-|fullTagEmptyElement|`boolean`|`true`|
-|addParent|`boolean`|`false`|
-|trim|`boolean`|`true`|
-|spaces|`number`|`2`|
+| name | value type | value | description |
+|:---|---|---:|:---|
+| `compact` | `boolean` | `true` ||
+| `declarationKey` | `string` | `__decl` ||
+| `attributesKey` | `string` | `__attr` ||
+| `textKey` | `string` | `__text` ||
+| `commentKey` | `string` | `__note` ||
+| `cdataKey` | `string` | `__cdata` ||
+| `nameKey` | `string` | `__name` ||
+| `typeKey` | `string` | `__type` ||
+| `parentKey` | `string` | `parent` ||
+| `elementsKey` | `string` | `items` ||
+| `ignoreDeclaration` | `boolean` | `false` ||
+| `ignoreDocType` | `boolean` | `false` ||
+| `ignoreInstractions` | `boolean` | `false` | \<*deprecated*> (*use `ignoreInstraction` instead*) |
+| `ignoreInstraction` | `boolean` | `false` ||
+| `ignoreText` | `boolean` | `false` ||
+| `ignoreComments` | `boolean` | `false` | \<*deprecated*> (*use `ignoreComment` instead*) |
+| `ignoreComment` | `boolean` | `false` ||
+| `ignoreCData` | `boolean` | `false` ||
+| `fullTagEmptyElement` | `boolean` | `true` ||
+| `addParent` | `boolean` | `false` ||
+| `trim` | `boolean` | `true` ||
+| `spaces` | `number` | `2` ||
 
 ### Base functions for read an object parameter value
 
@@ -1176,14 +1230,14 @@ The class constructor receives an arguments listed below:
 
 | property type | read only | description |
 |---|---|:---|
-| `object` | yes | returns an options for an XML-to-JS converter |
+| `xml2jsParseOptions` | yes | returns an options for an XML-to-JS converter |
 
 <a name="TXmlContentParseOptions+js2xml"></a>
 ###### **js2xml**
 
 | property type | read only | description |
 |---|---|:---|
-| `object` | yes | returns an options for a JS-to-XML converter |
+| `js2xmlParseOptions` | yes | returns an options for a JS-to-XML converter |
 
 <a name="TXmlContentParseOptions+reservedKeys"></a>
 ###### **reservedKeys**

package/index.d.ts

@@ -0,0 +1,76 @@
+declare const _exports: {
+    readXObjParamRaw: typeof import("./lib/xObj-lib").readXObjParamRaw;
+    readXObjParam: typeof import("./lib/xObj-lib").readXObjParam;
+    readXObjParamAsBool: typeof import("./lib/xObj-lib").readXObjParamAsBool;
+    readXObjParamAsNum: typeof import("./lib/xObj-lib").readXObjParamAsNum;
+    readXObjParamEx: typeof import("./lib/xObj-lib").readXObjParamEx;
+    readXObjParamAsIndex: typeof import("./lib/xObj-lib").readXObjParamAsIndex;
+    writeXObjParamRaw: typeof import("./lib/xObj-lib").writeXObjParamRaw;
+    writeXObjParam: typeof import("./lib/xObj-lib").writeXObjParam;
+    writeXObjParamAsBool: typeof import("./lib/xObj-lib").writeXObjParamAsBool;
+    writeXObjParamAsNum: typeof import("./lib/xObj-lib").writeXObjParamAsNum;
+    writeXObjParamAsIndex: typeof import("./lib/xObj-lib").writeXObjParamAsIndex;
+    writeXObjParamEx: typeof import("./lib/xObj-lib").writeXObjParamEx;
+    readXObjAttrRaw: typeof import("./lib/xObj-lib").readXObjAttrRaw;
+    readXObjAttr: typeof import("./lib/xObj-lib").readXObjAttr;
+    readXObjAttrAsBool: typeof import("./lib/xObj-lib").readXObjAttrAsBool;
+    readXObjAttrAsNum: typeof import("./lib/xObj-lib").readXObjAttrAsNum;
+    readXObjAttrEx: typeof import("./lib/xObj-lib").readXObjAttrEx;
+    readXObjAttrAsIndex: typeof import("./lib/xObj-lib").readXObjAttrAsIndex;
+    writeXObjAttrRaw: typeof import("./lib/xObj-lib").writeXObjAttrRaw;
+    writeXObjAttr: typeof import("./lib/xObj-lib").writeXObjAttr;
+    writeXObjAttrAsBool: typeof import("./lib/xObj-lib").writeXObjAttrAsBool;
+    writeXObjAttrAsNum: typeof import("./lib/xObj-lib").writeXObjAttrAsNum;
+    writeXObjAttrAsIndex: typeof import("./lib/xObj-lib").writeXObjAttrAsIndex;
+    writeXObjAttrEx: typeof import("./lib/xObj-lib").writeXObjAttrEx;
+    getXObjAttributes: typeof import("./lib/xObj-lib").getXObjAttributes;
+    checkXObjAttribute: typeof import("./lib/xObj-lib").checkXObjAttribute;
+    deleteXObjAttribute: typeof import("./lib/xObj-lib").deleteXObjAttribute;
+    renameXObjAttribute: typeof import("./lib/xObj-lib").renameXObjAttribute;
+    getXObjElement: typeof import("./lib/xObj-lib").getXObjElement;
+    addXObjElement: typeof import("./lib/xObj-lib").addXObjElement;
+    insertXObjElement: typeof import("./lib/xObj-lib").insertXObjElement;
+    insertXObjElementEx: typeof import("./lib/xObj-lib").insertXObjElementEx;
+    deleteXObjElement: typeof import("./lib/xObj-lib").deleteXObjElement;
+    deleteXObjElementEx: typeof import("./lib/xObj-lib").deleteXObjElementEx;
+    renameXObjElement: typeof import("./lib/xObj-lib").renameXObjElement;
+    evalXObjEName: typeof import("./lib/xObj-lib").evalXObjEName;
+    insertXObjEList: typeof import("./lib/xObj-lib").insertXObjEList;
+    insertXObjEListEx: typeof import("./lib/xObj-lib").insertXObjEListEx;
+    evalKeyName: typeof import("./lib/xObj-lib").evalKeyName;
+    genXObjENameDescr: typeof import("./lib/xObj-lib").genXObjENameDescr;
+    insertXObjElements: typeof import("./lib/xObj-lib").insertXObjElements;
+    insertXObjEChain: typeof import("./lib/xObj-lib").insertXObjEChain;
+    TXmlContentParseOptions: typeof TXmlContentParseOptions;
+    DEF_XML_PARSE_OPTIONS: typeof DEF_XML_PARSE_OPTIONS;
+    XOBJ_DEF_TNAMES: typeof XOBJ_DEF_TNAMES;
+    EvalKeyNameError: typeof EvalKeyNameError;
+
+    xml2jsParseOptions: xml2jsParseOptions;
+    js2xmlParseOptions: js2xmlParseOptions;
+    OPT_parserOptions: OPT_parserOptions;
+
+    XObjENameDescr: XObjENameDescr;
+    OPT_inselops_L: OPT_inselops_L;
+    OPT_inselops_S: OPT_inselops_S;
+    RVAL_reason: RVAL_reason;
+    RVAL_emodif: RVAL_emodif;
+    VCOR_evalkname: VCOR_evalkname;
+};
+export = _exports;
+import { TXmlContentParseOptions } from "./lib/xObj-defs";
+import { DEF_XML_PARSE_OPTIONS } from "./lib/xObj-defs";
+import { XOBJ_DEF_TNAMES } from "./lib/xObj-defs";
+import { EvalKeyNameError } from "./lib/xObj-errors";
+
+import type {
+  xml2jsParseOptions, js2xmlParseOptions,
+  OPT_parserOptions,
+} from "./lib/xObj-defs";
+
+import type {
+  XObjENameDescr,
+  OPT_inselops_L, OPT_inselops_S,
+  RVAL_reason, RVAL_emodif,
+  VCOR_evalkname,
+} from "./lib/xObj-lib";

package/index.js

@@ -1,18 +1,27 @@
-// [v0.1.012-20240624]
+// [v0.1.014-20251228]
 
 // === module init block ===
 
 const {
   TXmlContentParseOptions,
   DEF_XML_PARSE_OPTIONS,
+  XOBJ_DEF_TNAMES,
 } = require('./lib/xObj-defs');
 
-// === module extra block (helper functions) ===
+const {
+  EvalKeyNameError,
+} = require('./lib/xObj-errors');
+
+// === module inner block ===
 
 // === module main block ===
 
 // === module exports block ===
 
 module.exports = require('./lib/xObj-lib');
+
 module.exports.TXmlContentParseOptions = TXmlContentParseOptions;
 module.exports.DEF_XML_PARSE_OPTIONS = DEF_XML_PARSE_OPTIONS;
+module.exports.XOBJ_DEF_TNAMES = XOBJ_DEF_TNAMES;
+
+module.exports.EvalKeyNameError = EvalKeyNameError;

package/lib/xObj-defs.d.ts

@@ -0,0 +1,142 @@
+/**
+ * A parser options settings
+ */
+export type OPT_parserOptions = {
+    compact?: boolean;
+    declarationKey?: string;
+    attributesKey?: string;
+    textKey?: string;
+    commentKey?: string;
+    cdataKey?: string;
+    nameKey?: string;
+    typeKey?: string;
+    parentKey?: string;
+    elementsKey?: string;
+    ignoreDeclaration?: boolean;
+    ignoreDocType?: boolean;
+    ignoreInstraction?: boolean;
+    ignoreText?: boolean;
+    ignoreComment?: boolean;
+    ignoreCData?: boolean;
+    fullTagEmptyElement?: boolean;
+    addParent?: boolean;
+    trim?: boolean;
+    spaces?: any;
+};
+/**
+ * A parser options to convert an 'XML'-string into a 'JS'-object
+ */
+export type xml2jsParseOptions = {
+    compact?: boolean;
+    declarationKey?: string;
+    attributesKey?: string;
+    textKey?: string;
+    commentKey?: string;
+    cdataKey?: string;
+    nameKey?: string;
+    typeKey?: string;
+    parentKey?: string;
+    elementsKey?: string;
+    ignoreDeclaration?: boolean;
+    ignoreDocType?: boolean;
+    ignoreInstraction?: boolean;
+    ignoreText?: boolean;
+    ignoreComment?: boolean;
+    ignoreCData?: boolean;
+    addParent?: boolean;
+    trim?: boolean;
+};
+/**
+ * A parser options to convert a 'JS'-object into an 'XML'-string
+ */
+export type js2xmlParseOptions = {
+    compact?: boolean;
+    declarationKey?: string;
+    attributesKey?: string;
+    textKey?: string;
+    commentKey?: string;
+    cdataKey?: string;
+    nameKey?: string;
+    typeKey?: string;
+    parentKey?: string;
+    elementsKey?: string;
+    ignoreDeclaration?: boolean;
+    ignoreDocType?: boolean;
+    ignoreInstraction?: boolean;
+    ignoreText?: boolean;
+    ignoreComment?: boolean;
+    ignoreCData?: boolean;
+    fullTagEmptyElement?: boolean;
+    spaces?: any;
+};
+
+export const XOBJ_DEF_PARAM_TNAME: "__text";
+export const XOBJ_DEF_ATTR_TNAME: "__attr";
+export namespace XOBJ_DEF_TNAMES {
+    export { XOBJ_DEF_PARAM_TNAME };
+    export { XOBJ_DEF_ATTR_TNAME };
+    export { XOBJ_DEF_DECL_TNAME };
+    export { XOBJ_DEF_CDATA_TNAME };
+}
+export namespace DEF_XML_PARSE_OPTIONS {
+    export let compact: boolean;
+    export { XOBJ_DEF_DECL_TNAME as declarationKey };
+    export { XOBJ_DEF_ATTR_TNAME as attributesKey };
+    export { XOBJ_DEF_PARAM_TNAME as textKey };
+    export let commentKey: string;
+    export { XOBJ_DEF_CDATA_TNAME as cdataKey };
+    export let nameKey: string;
+    export let typeKey: string;
+    export let parentKey: string;
+    export let elementsKey: string;
+    export let ignoreDeclaration: boolean;
+    export let ignoreDocType: boolean;
+    /** @deprecated */
+    export let ignoreInstractions: boolean;
+    export let ignoreInstraction: boolean;
+    export let ignoreText: boolean;
+    /** @deprecated */
+    export let ignoreComments: boolean;
+    export let ignoreComment: boolean;
+    export let ignoreCData: boolean;
+    export let fullTagEmptyElement: boolean;
+    export let addParent: boolean;
+    export let trim: boolean;
+    export let spaces: number;
+}
+
+/**
+ * @classdesc Implements a container that provide a functionality to work
+ *    with options for an XML-parser
+ */
+export class TXmlContentParseOptions {
+    /**
+     * Creates a container instance
+     */
+    static createNewOptionsSet(opt?: any): OPT_parserOptions;
+    /**
+     * Creates a container instance
+     */
+    constructor(param?: any);
+    /**
+     * Contains a set of a current settings
+     */
+    get settings(): OPT_parserOptions;
+    /**
+     * Contains a set of a settings for converting an 'XML' to 'JS'-object
+     */
+    get xml2js(): xml2jsParseOptions;
+    /**
+     * Contains a set of a settings for converting an 'JS'-object to 'XML'
+     */
+    get js2xml(): js2xmlParseOptions;
+    /**
+     * Contains a set of a reserved key words
+     */
+    get reservedKeys(): Set<string>;
+    #private;
+}
+
+declare const XOBJ_DEF_DECL_TNAME: "__decl";
+declare const XOBJ_DEF_CDATA_TNAME: "__cdata";
+export {};

package/lib/xObj-defs.js

@@ -1,4 +1,4 @@
-// [v0.1.064-20250718]
+// [v0.1.068-20251229]
 
 // === module init block ===
 
@@ -6,7 +6,7 @@ const {
   isPlainObject,
 } = require('@ygracs/bsfoc-lib-js');
 
-// === module extra block (helper functions) ===
+// === module inner block ===
 
 // === module main block ===
 
@@ -16,52 +16,62 @@ const {
 
 const XOBJ_DEF_PARAM_TNAME = '__text';
 const XOBJ_DEF_ATTR_TNAME = '__attr';
+const XOBJ_DEF_DECL_TNAME = '__decl';
+const XOBJ_DEF_CDATA_TNAME = '__cdata';
 
-const XOBJ_TE_INVARG_EMSG = 'invalid argument';
-const XOBJ_TE_NOBJ_EMSG = `${XOBJ_TE_INVARG_EMSG} (an object expected)`;
-const XOBJ_TE_NOBJ_ECODE = 'ERR_XOBJ_NOBJ';
-const XOBJ_TE_NARR_EMSG = `${XOBJ_TE_INVARG_EMSG} (an array expected)`;
-const XOBJ_TE_NARR_ECODE = 'ERR_XOBJ_NARR';
-const XOBJ_TE_NSTR_EMSG = `${XOBJ_TE_INVARG_EMSG} (a string expected)`;
-const XOBJ_TE_NSTR_ECODE = 'ERR_XOBJ_NSTR';
-const XOBJ_TE_NPOBJ_EMSG = `${XOBJ_TE_INVARG_EMSG} (a plain object expected)`;
-const XOBJ_TE_NPOBJ_ECODE = 'ERR_XOBJ_NPOBJ';
-const XOBJ_TE_ANES_EMSG = '<attr_name> must be a non-empty string';
-const XOBJ_TE_ANES_ECODE = 'ERR_XOBJ_INVARG_ATTR';
-const XOBJ_TE_KNES_EMSG = '<key_name> must be a non-empty string';
-const XOBJ_TE_KNES_ECODE = 'ERR_XOBJ_INVARG_KEY';
-
-const XOBJ_ECODE_TABLE = {
-  XOBJ_TE_NOBJ_EMSG,
-  XOBJ_TE_NOBJ_ECODE,
-  XOBJ_TE_NARR_EMSG,
-  XOBJ_TE_NARR_ECODE,
-  XOBJ_TE_NSTR_EMSG,
-  XOBJ_TE_NSTR_ECODE,
-  XOBJ_TE_NPOBJ_EMSG,
-  XOBJ_TE_NPOBJ_ECODE,
-  XOBJ_TE_ANES_EMSG,
-  XOBJ_TE_ANES_ECODE,
-  XOBJ_TE_KNES_EMSG,
-  XOBJ_TE_KNES_ECODE,
+const XOBJ_DEF_TNAMES = {
+  XOBJ_DEF_PARAM_TNAME,
+  XOBJ_DEF_ATTR_TNAME,
+  XOBJ_DEF_DECL_TNAME,
+  XOBJ_DEF_CDATA_TNAME,
 };
 
+/**
+ * A parser options settings
+ * @typedef {Object} OPT_parserOptions
+ * @property {boolean} [compact]
+ * @property {string} [declarationKey]
+ * @property {string} [attributesKey]
+ * @property {string} [textKey]
+ * @property {string} [commentKey]
+ * @property {string} [cdataKey]
+ * @property {string} [nameKey]
+ * @property {string} [typeKey]
+ * @property {string} [parentKey]
+ * @property {string} [elementsKey]
+ * @property {boolean} [ignoreDeclaration]
+ * @property {boolean} [ignoreDocType]
+ * @property {boolean} [ignoreInstraction]
+ * @property {boolean} [ignoreText]
+ * @property {boolean} [ignoreComment]
+ * @property {boolean} [ignoreCData]
+ * @property {boolean} [fullTagEmptyElement]
+ * @property {boolean} [addParent]
+ * @property {boolean} [trim]
+ * @property {any} [spaces]
+ */
+
+/** @type {OPT_parserOptions} */
 const DEF_XML_PARSE_OPTIONS = {
   compact: true,
-  declarationKey: '__decl',
+  declarationKey: XOBJ_DEF_DECL_TNAME,
   attributesKey: XOBJ_DEF_ATTR_TNAME,
   textKey: XOBJ_DEF_PARAM_TNAME,
   commentKey: '__note',
-  cdataKey: '__cdata',
+  cdataKey: XOBJ_DEF_CDATA_TNAME,
   nameKey: '__name',
   typeKey: '__type',
   parentKey: 'parent',
   elementsKey: 'items',
   ignoreDeclaration: false,
   ignoreDocType: false,
+  /** @deprecated */
   ignoreInstractions: false,
+  ignoreInstraction: false,
   ignoreText: false,
+  /** @deprecated */
   ignoreComments: false,
+  ignoreComment: false,
   ignoreCData: false,
   fullTagEmptyElement: true,
   addParent: false,
@@ -77,13 +87,59 @@ const DEF_XML_PARSE_OPTIONS = {
  * (* class definitions *)
  */
 
+/**
+ * A parser options to convert an 'XML'-string into a 'JS'-object
+ * @typedef {Object} xml2jsParseOptions
+ * @property {boolean} [compact]
+ * @property {string} [declarationKey]
+ * @property {string} [attributesKey]
+ * @property {string} [textKey]
+ * @property {string} [commentKey]
+ * @property {string} [cdataKey]
+ * @property {string} [nameKey]
+ * @property {string} [typeKey]
+ * @property {string} [parentKey]
+ * @property {string} [elementsKey]
+ * @property {boolean} [ignoreDeclaration]
+ * @property {boolean} [ignoreDocType]
+ * @property {boolean} [ignoreInstraction]
+ * @property {boolean} [ignoreText]
+ * @property {boolean} [ignoreComment]
+ * @property {boolean} [ignoreCData]
+ * @property {boolean} [addParent]
+ * @property {boolean} [trim]
+ */
+
+/**
+ * A parser options to convert a 'JS'-object into an 'XML'-string
+ * @typedef {Object} js2xmlParseOptions
+ * @property {boolean} [compact]
+ * @property {string} [declarationKey]
+ * @property {string} [attributesKey]
+ * @property {string} [textKey]
+ * @property {string} [commentKey]
+ * @property {string} [cdataKey]
+ * @property {string} [nameKey]
+ * @property {string} [typeKey]
+ * @property {string} [parentKey]
+ * @property {string} [elementsKey]
+ * @property {boolean} [ignoreDeclaration]
+ * @property {boolean} [ignoreDocType]
+ * @property {boolean} [ignoreInstraction]
+ * @property {boolean} [ignoreText]
+ * @property {boolean} [ignoreComment]
+ * @property {boolean} [ignoreCData]
+ * @property {boolean} [fullTagEmptyElement]
+ * @property {any} [spaces]
+ */
+
 /**
  * @classdesc Implements a container that provide a functionality to work
  *    with options for an XML-parser
  */
 class TXmlContentParseOptions {
-  /** @type {object} */
-  #_options = null;
+  /** @type {OPT_parserOptions} */
+  #_options;
 
   /**
    * Creates a container instance
@@ -95,7 +151,7 @@ class TXmlContentParseOptions {
 
   /**
    * Contains a set of a current settings
-   * @type {object}
+   * @type {OPT_parserOptions}
    */
   get settings() {
     return this.#_options;
@@ -103,7 +159,7 @@ class TXmlContentParseOptions {
 
   /**
    * Contains a set of a settings for converting an 'XML' to 'JS'-object
-   * @type {object}
+   * @type {xml2jsParseOptions}
    */
   get xml2js() {
     let _settings = this.#_options;
@@ -120,9 +176,9 @@ class TXmlContentParseOptions {
       elementsKey: _settings.elementsKey,
       ignoreDeclaration: _settings.ignoreDeclaration,
       ignoreDocType: _settings.ignoreDocType,
-      ignoreInstraction: _settings.ignoreInstractions,
+      ignoreInstraction: _settings.ignoreInstraction,
       ignoreText: _settings.ignoreText,
-      ignoreComment: _settings.ignoreComments,
+      ignoreComment: _settings.ignoreComment,
       ignoreCData: _settings.ignoreCData,
       addParent: _settings.addParent,
       trim: _settings.trim,
@@ -131,7 +187,7 @@ class TXmlContentParseOptions {
 
   /**
    * Contains a set of a settings for converting an 'JS'-object to 'XML'
-   * @type {object}
+   * @type {js2xmlParseOptions}
    */
   get js2xml() {
     let _settings = this.#_options;
@@ -148,9 +204,9 @@ class TXmlContentParseOptions {
       elementsKey: _settings.elementsKey,
       ignoreDeclaration: _settings.ignoreDeclaration,
       ignoreDocType: _settings.ignoreDocType,
-      ignoreInstraction: _settings.ignoreInstractions,
+      ignoreInstraction: _settings.ignoreInstraction,
       ignoreText: _settings.ignoreText,
-      ignoreComment: _settings.ignoreComments,
+      ignoreComment: _settings.ignoreComment,
       ignoreCData: _settings.ignoreCData,
       fullTagEmptyElement: _settings.fullTagEmptyElement,
       spaces: _settings.spaces,
@@ -189,6 +245,7 @@ class TXmlContentParseOptions {
   /**
    * Creates a container instance
    * @param {any} [opt] - some initial options set
+   * @returns {OPT_parserOptions}
    * @static
    */
   static createNewOptionsSet(opt) {
@@ -212,9 +269,9 @@ class TXmlContentParseOptions {
       elementsKey: opt.elementsKey,
       ignoreDeclaration: opt.ignoreDeclaration,
       ignoreDocType: opt.ignoreDocType,
-      ignoreInstractions: opt.ignoreInstractions,
+      ignoreInstraction: opt.ignoreInstraction,
       ignoreText: opt.ignoreText,
-      ignoreComments: opt.ignoreComments,
+      ignoreComment: opt.ignoreComment,
       ignoreCData: opt.ignoreCData,
       fullTagEmptyElement: opt.fullTagEmptyElement,
       addParent: opt.addParent,
@@ -229,7 +286,7 @@ class TXmlContentParseOptions {
 
 module.exports.XOBJ_DEF_PARAM_TNAME = XOBJ_DEF_PARAM_TNAME;
 module.exports.XOBJ_DEF_ATTR_TNAME = XOBJ_DEF_ATTR_TNAME;
-module.exports.XOBJ_ECODE_TABLE = XOBJ_ECODE_TABLE;
+module.exports.XOBJ_DEF_TNAMES = XOBJ_DEF_TNAMES;
 module.exports.DEF_XML_PARSE_OPTIONS = DEF_XML_PARSE_OPTIONS;
 
 module.exports.TXmlContentParseOptions = TXmlContentParseOptions;

package/lib/xObj-errors.d.ts

@@ -0,0 +1,41 @@
+export namespace XOBJ_ECODE_TABLE {
+    export { XOBJ_TE_NOBJ_EMSG };
+    export { XOBJ_TE_NOBJ_ECODE };
+    export { XOBJ_TE_NARR_EMSG };
+    export { XOBJ_TE_NARR_ECODE };
+    export { XOBJ_TE_NSTR_EMSG };
+    export { XOBJ_TE_NSTR_ECODE };
+    export { XOBJ_TE_NPOBJ_EMSG };
+    export { XOBJ_TE_NPOBJ_ECODE };
+    export { XOBJ_TE_ANES_EMSG };
+    export { XOBJ_TE_ANES_ECODE };
+    export { XOBJ_TE_KNES_EMSG };
+    export { XOBJ_TE_KNES_ECODE };
+}
+/**
+ * @classdesc Extends a base `TypeError` object to provide some information
+ *            on the errors thrown when a key name evaluation failed
+ */
+export class EvalKeyNameError extends TypeError {
+    /**
+     * Creates a new instance
+     */
+    constructor(msg: string, options?: any);
+    /**
+     * Represents an error code
+     */
+    code: string;
+}
+declare const XOBJ_TE_NOBJ_EMSG: "invalid argument (an object expected)";
+declare const XOBJ_TE_NOBJ_ECODE: "ERR_XOBJ_NOBJ";
+declare const XOBJ_TE_NARR_EMSG: "invalid argument (an array expected)";
+declare const XOBJ_TE_NARR_ECODE: "ERR_XOBJ_NARR";
+declare const XOBJ_TE_NSTR_EMSG: "invalid argument (a string expected)";
+declare const XOBJ_TE_NSTR_ECODE: "ERR_XOBJ_NSTR";
+declare const XOBJ_TE_NPOBJ_EMSG: "invalid argument (a plain object expected)";
+declare const XOBJ_TE_NPOBJ_ECODE: "ERR_XOBJ_NPOBJ";
+declare const XOBJ_TE_ANES_EMSG: "<attr_name> must be a non-empty string";
+declare const XOBJ_TE_ANES_ECODE: "ERR_XOBJ_INVARG_ATTR";
+declare const XOBJ_TE_KNES_EMSG: "<key_name> must be a non-empty string";
+declare const XOBJ_TE_KNES_ECODE: "ERR_XOBJ_INVARG_KEY";
+export {};