@ygracs/xobj-lib-js 0.3.0-beta.0 → 0.3.0

package/CHANGELOG.md

@@ -1,4 +1,4 @@
-#### *v0.3.x*
+#### *v0.3.0*
 
 Release version.
 

package/README.md

@@ -1,6 +1,6 @@
-|***rev.*:**|0.1.3|
+|***rev.*:**|0.1.4|
 |:---|---:|
-|***date***:|2026-02-28|
+|***date***:|2026-03-03|
 
 ## Introduction
 
@@ -16,3 +16,5 @@ This module provide a helper functions for object manipulation. It was primarily
 ### Installation
 
 `npm install @ygracs/xobj-lib-js`
+
+> Note: It's recommended to "pin" a package versions range to its minor releases after installation. To do so use `~` range specifier (*e.g. `~0.3.0`*) in `package.json`.

package/doc/xObj.md

@@ -1,6 +1,6 @@
->|***rev.*:**|0.1.51|
+>|***rev.*:**|0.1.52|
 >|:---|---:|
->|date:|2026-02-28|
+>|date:|2026-03-03|
 
 ## Introduction
 
@@ -676,6 +676,9 @@ The function throws a `TypeError` exception in case:
 
 - code: `ERR_XOBJ_NPOBJ`
   + if `object` parameter is not an `Object` instance;
+
+The function throws a `EvalKeyNameError` exception in case:
+
 - code: `ERR_XOBJ_NSTR`
   + if `key` parameter given and is not a type of a `string`.
 
@@ -702,6 +705,9 @@ The function throws a `TypeError` exception in case:
 
 - code: `ERR_XOBJ_NPOBJ`
   + if `object` parameter is not an `Object` instance;
+
+The function throws a `EvalKeyNameError` exception in case:
+
 - code: `ERR_XOBJ_NSTR`
   + if `key` parameter given and is not a type of a `string`.
 
@@ -729,6 +735,9 @@ The function throws a `TypeError` exception in case:
 
 - code: `ERR_XOBJ_NPOBJ`
   + if `object` parameter is not an `Object` instance;
+
+The function throws a `EvalKeyNameError` exception in case:
+
 - code: `ERR_XOBJ_NSTR`
   + if `attr` parameter given and is not a type of a `string`;
   + if `key` parameter given and is not a type of a `string`.
@@ -757,6 +766,9 @@ The function throws a `TypeError` exception in case:
 
 - code: `ERR_XOBJ_NPOBJ`
   + if `object` parameter is not an `Object` instance;
+
+The function throws a `EvalKeyNameError` exception in case:
+
 - code: `ERR_XOBJ_NSTR`
   + if `attr` parameter given and is not a type of a `string`;
   + if `key` parameter given and is not a type of a `string`.
@@ -804,6 +816,9 @@ The function throws a `TypeError` exception in case:
 
 - code: `ERR_XOBJ_NPOBJ`
   + if `object` parameter is not an `Object` instance;
+
+The function throws a `EvalKeyNameError` exception in case:
+
 - code: `ERR_XOBJ_NSTR`
   + if `attr` parameter given and is not a type of a `string`;
   + if `key` parameter given and is not a type of a `string`.
@@ -827,6 +842,9 @@ The function throws a `TypeError` exception in case:
 
 - code: `ERR_XOBJ_NPOBJ`
   + if `object` parameter is not an `Object` instance;
+
+The function throws a `EvalKeyNameError` exception in case:
+
 - code: `ERR_XOBJ_NSTR`
   + if `attr` parameter given and is not a type of a `string`;
   + if `key` parameter given and is not a type of a `string`.
@@ -853,6 +871,9 @@ The function throws a `TypeError` exception in case:
 
 - code: `ERR_XOBJ_NPOBJ`
   + if `object` parameter is not an `Object` instance;
+
+The function throws a `EvalKeyNameError` exception in case:
+
 - code: `ERR_XOBJ_NSTR`
   + if `attr` parameter given and is not a type of a `string`;
   + if `value` parameter given and is not a type of a `string`;
@@ -878,6 +899,9 @@ The function throws a `TypeError` exception in case:
 
 - code: `ERR_XOBJ_NPOBJ`
   + if `object` parameter is not an `Object` instance;
+
+The function throws a `EvalKeyNameError` exception in case:
+
 - code: `ERR_XOBJ_NSTR`
   + if `name` parameter given and is not a type of a `string`;
 - code: `ERR_XOBJ_INVARG_KEY`
@@ -931,6 +955,9 @@ The function throws a `TypeError` exception in case:
 
 - code: `ERR_XOBJ_NPOBJ`
   + if `object` parameter is not an `Object` instance;
+
+The function throws a `EvalKeyNameError` exception in case:
+
 - code: `ERR_XOBJ_NSTR`
   + if `name` parameter given and is not a type of a `string`;
 - code: `ERR_XOBJ_INVARG_KEY`
@@ -1000,6 +1027,9 @@ The function throws a `TypeError` exception in case:
 
 - code: `ERR_XOBJ_NPOBJ`
   + if `object` parameter is not an `Object` instance;
+
+The function throws a `EvalKeyNameError` exception in case:
+
 - code: `ERR_XOBJ_NSTR`
   + if `name` parameter given and is not a type of a `string`;
 - code: `ERR_XOBJ_INVARG_KEY`
@@ -1049,6 +1079,9 @@ The function throws a `TypeError` exception in case:
 
 - code: `ERR_XOBJ_NPOBJ`
   + if `object` parameter is not an `Object` instance;
+
+The function throws a `EvalKeyNameError` exception in case:
+
 - code: `ERR_XOBJ_NSTR`
   + if `name` parameter given and is not a type of a `string`;
 - code: `ERR_XOBJ_INVARG_KEY`
@@ -1073,6 +1106,9 @@ The function throws a `TypeError` exception in case:
 
 - code: `ERR_XOBJ_NPOBJ`
   + if `object` parameter is not an `Object` instance;
+
+The function throws a `EvalKeyNameError` exception in case:
+
 - code: `ERR_XOBJ_NSTR`
   + if `name` parameter given and is not a type of a `string`;
   + id `value` parameter given and is not a type of a `string`.
@@ -1080,7 +1116,7 @@ The function throws a `TypeError` exception in case:
 <a name="clearXObjNode"></a>
 #### **clearXObjNode(node)** => `boolean`
 
-> since: \[v0.2.x]
+> since: \[v0.3.0]
 
 This function tries to clean a given node.
 
@@ -1184,6 +1220,9 @@ The function throws a `TypeError` exception in case:
 
 - code: `ERR_XOBJ_NPOBJ`
   + if `object` parameter is not an `Object` instance;
+
+The function throws a `EvalKeyNameError` exception in case:
+
 - code: `ERR_XOBJ_NSTR`
   + if `name` parameter given and is not a type of a `string`;
 - code: `ERR_XOBJ_INVARG_KEY`
@@ -1285,7 +1324,7 @@ The class constructor receives an arguments listed below:
 <a name="TXmlContentParseOptions+compact"></a>
 ###### **compact**
 
-> since: \[v0.2.x]
+> since: \[v0.3.0]
 
 | property type | read only | description |
 |---|---|:---|
@@ -1332,7 +1371,7 @@ This method transforms a given object to a set of accepted parser options.
 <a name="EvalKeyNameError"></a>
 #### **EvalKeyNameError**
 
-> since: \[v0.2.x]
+> since: \[v0.3.0]
 
 This class extends a functionality of a `TypeError`-object to provide more accurate information when an error happened through a key evaluation.
 

package/index.d.ts

@@ -9,8 +9,8 @@ export {
 };
 
 import type {
-  xml2jsParseOptions, js2xmlParseOptions,
-  OPT_parserOptions,
+    xml2jsParseOptions, js2xmlParseOptions,
+    OPT_parserOptions,
 } from "./lib/xObj-defs";
 
 export type {
@@ -93,15 +93,17 @@ export {
 };
 
 import type {
-  XObjENameDescr,
-  OPT_inselops_L, OPT_inselops_S,
-  RVAL_reason, RVAL_emodif,
-  VCOR_evalkname,
+    XObjENameDescr, XObjENameDescrConditions,
+    OPT_inselops_L, OPT_inselops_S,
+    RVAL_emodif,
+    VCOR_evalkname, RVAL_reason,
+    IEvalKeyNameResult,
 } from "./lib/xObj-lib";
 
 export type {
-    XObjENameDescr,
+    XObjENameDescr, XObjENameDescrConditions,
     OPT_inselops_L, OPT_inselops_S,
-    RVAL_reason, RVAL_emodif,
-    VCOR_evalkname,
+    RVAL_emodif,
+    VCOR_evalkname, RVAL_reason,
+    IEvalKeyNameResult,
 };

package/lib/xObj-lib.d.ts

@@ -1,4 +1,17 @@
 import type { EvalKeyNameError } from "./xObj-errors";
+/**
+ * An error description of a value check ops on fail.
+ */
+export type IEvalKeyNameReasonOnFail = {
+    /**
+     * - message ID
+     */
+    code: string;
+    /**
+     * - message text
+     */
+    msg: string;
+};
 /**
  * A result of a value check ops.
  */
@@ -19,7 +32,7 @@ export type IEvalKeyNameOptions = {
     /**
      * - a flag to accept only a non-empty string values
      */
-    onlyNES?: boolean | undefined;
+    onlyNES?: boolean;
 };
 /**
  * A result of `evalKeyName` function if succeed
@@ -45,7 +58,7 @@ export type IEvalKeyNameResultOnFail = {
     /**
      * - reason of fail
      */
-    value: RVAL_reason;
+    value: IEvalKeyNameReasonOnFail;
 };
 /**
  * A result of `evalKeyName` function
@@ -64,6 +77,24 @@ export type VCOR_evalkname = {
      */
     value: string | RVAL_reason;
 };
+/**
+ * Some conditions applied to an element as a result of an element name pattern
+ * evaluation ops.
+ */
+export type XObjENameDescrConditions = {
+    /**
+     * - element name
+     */
+    name: any;
+    /**
+     * - element type
+     */
+    type: any;
+    /**
+     * - some value
+     */
+    value?: any;
+};
 /**
  * A result of an element name pattern evaluation ops.
  */
@@ -79,7 +110,7 @@ export type XObjENameDescr = {
     /**
      * - some conditions applied to an element
      */
-    conditions: object | null;
+    conditions: XObjENameDescrConditions | null;
 };
 /**
  * A result of an xObj modification ops
@@ -118,142 +149,142 @@ export type OPT_inselops_S = {
  */
 export function addXObjElementEx(obj: object, name: string): RVAL_emodif;
 /**
- * Clears a given node
- * @throws {TypeError} if `node`-param is not an object or array
+ * Extracts a parameter from a given object and returns it as a boolean.
+ * @throws {TypeError} if `obj` param is not an object
  */
-export function clearXObjNode(node: object | object[]): boolean;
+export function readXObjParamAsBool(obj: object, defValue?: boolean, key?: string): boolean;
 /**
- * Extracts a parameter 'AS IS' from a given object.
+ * Extracts a parameter from a given object and returns it as a number.
  * @throws {TypeError} if `obj` param is not an object
- * @throws {EvalKeyNameError} if `key` param is not valid identifier
  */
-export function readXObjParamRaw(obj: object, key?: string): any;
+export function readXObjParamAsNum(obj: object, defValue?: number, key?: string): number;
 /**
- * Extracts a parameter from a given object and returns it as a string.
+ * Extracts a parameter from a given object and returns it as 'index' value.
  * @throws {TypeError} if `obj` param is not an object
  */
-export function readXObjParam(obj: object, key?: string): string;
+export function readXObjParamAsIndex(obj: object, key?: string): number;
 /**
- * Extracts a parameter from a given object and returns it as a boolean.
+ * Tries to convert a given value to a boolean and writes it as a parameter
+ * into a given object.
  * @throws {TypeError} if `obj` param is not an object
  */
-export function readXObjParamAsBool(obj: object, defValue?: boolean, key?: string): boolean;
+export function writeXObjParamAsBool(obj: object, value: any, defValue?: boolean, key?: string): boolean;
 /**
- * Extracts a parameter from a given object and returns it as a number.
+ * Tries to convert a given value to a number and writes it as a parameter
+ * into a given object.
  * @throws {TypeError} if `obj` param is not an object
  */
-export function readXObjParamAsNum(obj: object, defValue?: number, key?: string): number;
+export function writeXObjParamAsNum(obj: object, value: any, defValue?: number, key?: string): boolean;
 /**
- * Extracts a parameter from a given object and returns it as a string.
+ * Tries to convert a given value into an 'index' value and writes it
+ * as a parameter into a given object.
  * @throws {TypeError} if `obj` param is not an object
- * @todo [since `v0.2.1`] deprecate use of `opt` as `string`
  */
-export function readXObjParamEx(obj: object, opt?: object, key?: string): string;
+export function writeXObjParamAsIndex(obj: object, value: any, key?: string): boolean;
 /**
- * Extracts a parameter from a given object and returns it as 'index' value.
+ * Extracts an attribute from a given object and returns it as a boolean.
  * @throws {TypeError} if `obj` param is not an object
  */
-export function readXObjParamAsIndex(obj: object, key?: string): number;
+export function readXObjAttrAsBool(obj: object, attr: string, defValue?: boolean, key?: string): boolean;
 /**
- * Writes a parameter 'AS IS' into a given object.
+ * Extracts an attribute from a given object and returns it as a number.
+ * @returns {number}
  * @throws {TypeError} if `obj` param is not an object
- * @throws {EvalKeyNameError} if `key` param is not valid identifier
  */
-export function writeXObjParamRaw(obj: object, value: any, key?: string): boolean;
+export function readXObjAttrAsNum(obj: object, attr: string, defValue?: number, key?: string): number;
 /**
- * Tries to convert a given value to a string and writes it as a parameter
- * into a given object.
+ * Extracts an attribute from a given object and returns it as 'index' value.
  * @throws {TypeError} if `obj` param is not an object
  */
-export function writeXObjParam(obj: object, value: any, key?: string): boolean;
+export function readXObjAttrAsIndex(obj: object, attr: string, key?: string): number;
 /**
- * Tries to convert a given value to a boolean and writes it as a parameter
+ * Tries to convert a given value to a boolean and writes it as an attribute
  * into a given object.
  * @throws {TypeError} if `obj` param is not an object
  */
-export function writeXObjParamAsBool(obj: object, value: any, defValue?: boolean, key?: string): boolean;
+export function writeXObjAttrAsBool(obj: object, attr: string, value: any, defValue?: boolean, key?: string): boolean;
 /**
- * Tries to convert a given value to a number and writes it as a parameter
+ * Tries to convert a given value to a number and writes it as an attribute
  * into a given object.
  * @throws {TypeError} if `obj` param is not an object
  */
-export function writeXObjParamAsNum(obj: object, value: any, defValue?: number, key?: string): boolean;
+export function writeXObjAttrAsNum(obj: object, attr: string, value: any, defValue?: number, key?: string): boolean;
 /**
  * Tries to convert a given value into an 'index' value and writes it
- * as a parameter into a given object.
+ * as an attribute into a given object.
  * @throws {TypeError} if `obj` param is not an object
  */
-export function writeXObjParamAsIndex(obj: object, value: any, key?: string): boolean;
+export function writeXObjAttrAsIndex(obj: object, attr: string, value: any, key?: string): boolean;
 /**
- * Tries to convert a given value to a string and writes it
- * as a parameter into a given object.
- * @throws {TypeError} if `obj` param is not an object
- * @todo [since `v0.2.1`] deprecate use of `opt` as `string`
+ * Clears a given node
+ * @throws {TypeError} if `node`-param is not an object or array
  */
-export function writeXObjParamEx(obj: object, value: any, opt?: object, key?: string): boolean;
+export function clearXObjNode(node: object | object[]): boolean;
 /**
- * Extracts an attribute 'AS IS' from a given object.
+ * Extracts a parameter 'AS IS' from a given object.
  * @throws {TypeError} if `obj` param is not an object
- * @throws {EvalKeyNameError} if `attr` param is not valid identifier
+ * @throws {EvalKeyNameError} if `key` param is not valid identifier
  */
-export function readXObjAttrRaw(obj: object, attr?: string, key?: string): any;
+export function readXObjParamRaw(obj: object, key?: string): any;
 /**
- * Extracts an attribute from a given object and returns it as a string.
+ * Extracts a parameter from a given object and returns it as a string.
  * @throws {TypeError} if `obj` param is not an object
  */
-export function readXObjAttr(obj: object, attr: string, key?: string): string;
+export function readXObjParam(obj: object, key?: string): string;
 /**
- * Extracts an attribute from a given object and returns it as a boolean.
+ * Extracts a parameter from a given object and returns it as a string.
  * @throws {TypeError} if `obj` param is not an object
+ * @todo [since `v0.2.1`] deprecate use of `opt` as `string`
  */
-export function readXObjAttrAsBool(obj: object, attr: string, defValue?: boolean, key?: string): boolean;
+export function readXObjParamEx(obj: object, opt?: object, key?: string): string;
 /**
- * Extracts an attribute from a given object and returns it as a number.
- * @returns {number}
+ * Writes a parameter 'AS IS' into a given object.
  * @throws {TypeError} if `obj` param is not an object
+ * @throws {EvalKeyNameError} if `key` param is not valid identifier
  */
-export function readXObjAttrAsNum(obj: object, attr: string, defValue?: number, key?: string): number;
+export function writeXObjParamRaw(obj: object, value: any, key?: string): boolean;
 /**
- * Extracts an attribute from a given object and returns it as a string.
+ * Tries to convert a given value to a string and writes it as a parameter
+ * into a given object.
  * @throws {TypeError} if `obj` param is not an object
- * @todo [since `v0.2.1`] deprecate use of `opt` as `string`
  */
-export function readXObjAttrEx(obj: object, attr: string, opt?: object, key?: string): string;
+export function writeXObjParam(obj: object, value: any, key?: string): boolean;
 /**
- * Extracts an attribute from a given object and returns it as 'index' value.
+ * Tries to convert a given value to a string and writes it
+ * as a parameter into a given object.
  * @throws {TypeError} if `obj` param is not an object
+ * @todo [since `v0.2.1`] deprecate use of `opt` as `string`
  */
-export function readXObjAttrAsIndex(obj: object, attr: string, key?: string): number;
+export function writeXObjParamEx(obj: object, value: any, opt?: object, key?: string): boolean;
 /**
- * Writes a parameter into a given object.
+ * Extracts an attribute 'AS IS' from a given object.
  * @throws {TypeError} if `obj` param is not an object
  * @throws {EvalKeyNameError} if `attr` param is not valid identifier
  */
-export function writeXObjAttrRaw(obj: object, attr: string, value: any, key?: string): boolean;
+export function readXObjAttrRaw(obj: object, attr?: string, key?: string): any;
 /**
- * Tries to convert a given value to a string and writes it as an attribute
- * into a given object.
+ * Extracts an attribute from a given object and returns it as a string.
  * @throws {TypeError} if `obj` param is not an object
  */
-export function writeXObjAttr(obj: object, attr: string, value: any, key?: string): boolean;
+export function readXObjAttr(obj: object, attr: string, key?: string): string;
 /**
- * Tries to convert a given value to a boolean and writes it as an attribute
- * into a given object.
+ * Extracts an attribute from a given object and returns it as a string.
  * @throws {TypeError} if `obj` param is not an object
+ * @todo [since `v0.2.1`] deprecate use of `opt` as `string`
  */
-export function writeXObjAttrAsBool(obj: object, attr: string, value: any, defValue?: boolean, key?: string): boolean;
+export function readXObjAttrEx(obj: object, attr: string, opt?: object, key?: string): string;
 /**
- * Tries to convert a given value to a number and writes it as an attribute
- * into a given object.
+ * Writes a parameter into a given object.
  * @throws {TypeError} if `obj` param is not an object
+ * @throws {EvalKeyNameError} if `attr` param is not valid identifier
  */
-export function writeXObjAttrAsNum(obj: object, attr: string, value: any, defValue?: number, key?: string): boolean;
+export function writeXObjAttrRaw(obj: object, attr: string, value: any, key?: string): boolean;
 /**
- * Tries to convert a given value into an 'index' value and writes it
- * as an attribute into a given object.
+ * Tries to convert a given value to a string and writes it as an attribute
+ * into a given object.
  * @throws {TypeError} if `obj` param is not an object
  */
-export function writeXObjAttrAsIndex(obj: object, attr: string, value: any, key?: string): boolean;
+export function writeXObjAttr(obj: object, attr: string, value: any, key?: string): boolean;
 /**
  * Tries to convert a given value to a string and writes it as an attribute
  * into a given object.

package/lib/xObj-lib.js

@@ -1,4 +1,4 @@
-// [v0.3.131-20260228]
+// [v0.3.134-20260303]
 
 // === module init block ===
 
@@ -37,11 +37,20 @@ const {
 
 // === module inner block ===
 
+/**
+ * An error description of a value check ops on fail.
+ * @since 0.3.0
+ * @typedef {Object} IEvalKeyNameReasonOnFail
+ * @property {string} code - message ID
+ * @property {string} msg - message text
+ */
+
 /**
  * A result of a value check ops.
  * @typedef {Object} RVAL_reason
  * @property {string} code - message ID
  * @property {string} msg - message text
+ * @todo \[from v0.3.0] make obsolete. Use `IEvalKeyNameReasonOnFail` instead.
  */
 
 /**
@@ -64,7 +73,7 @@ const {
  * @since 0.3.0
  * @typedef {Object} IEvalKeyNameResultOnFail
  * @property {false} isSucceed - ops flag
- * @property {RVAL_reason} value - reason of fail
+ * @property {IEvalKeyNameReasonOnFail} value - reason of fail
  */
 
 /**
@@ -165,12 +174,22 @@ function evalXObjEName(value) {
   return name;
 };
 
+/**
+ * Some conditions applied to an element as a result of an element name pattern
+ * evaluation ops.
+ * @since 0.3.0
+ * @typedef {Object} XObjENameDescrConditions
+ * @property {any} name - element name
+ * @property {any} type - element type
+ * @property {any} [value] - some value
+ */
+
 /**
  * A result of an element name pattern evaluation ops.
  * @typedef {Object} XObjENameDescr
  * @property {boolean} isERR - ops flag
  * @property {(null|number|string)} name - element name
- * @property {?object} conditions - some conditions applied to an element
+ * @property {?XObjENameDescrConditions} conditions - some conditions applied to an element
  */
 
 /**
@@ -856,6 +875,7 @@ function readXObjParamAsBool(obj, defValue, key) {
   };
   return readAsBoolEx(result, defValue);
 };
+module.exports.readXObjParamAsBool = readXObjParamAsBool;
 
 /**
  * Extracts a parameter from a given object and returns it as a number.
@@ -883,18 +903,17 @@ function readXObjParamAsNum(obj, defValue, key) {
   };
   return readAsNumberEx(result, defValue);
 };
+module.exports.readXObjParamAsNum = readXObjParamAsNum;
 
 /**
- * Extracts a parameter from a given object and returns it as a string.
- * @function readXObjParamEx
+ * Extracts a parameter from a given object and returns it as 'index' value.
+ * @function readXObjParamAsIndex
  * @param {object} obj - some object
- * @param {object} [opt] - options
  * @param {string} [key] - some key
- * @returns {string}
+ * @returns {number}
  * @throws {TypeError} if `obj` param is not an object
- * @todo [since `v0.2.1`] deprecate use of `opt` as `string`
  */
-function readXObjParamEx(obj, opt, key) {
+function readXObjParamAsIndex(obj, key) {
   let result = undefined;
   try {
     result = readXObjParamRaw(obj, key);
@@ -908,25 +927,21 @@ function readXObjParamEx(obj, opt, key) {
       }
     };
   };
-  /** @type {OPT_valtostr} */
-  const _opt = isPlainObject(opt) ? opt : {
-    useTrim: false,
-    numberToString: true,
-    boolToString: true,
-    defValue: opt,
-  };
-  return readAsString(result, _opt);
+  return valueToIndex(result);
 };
+module.exports.readXObjParamAsIndex = readXObjParamAsIndex;
 
 /**
- * Extracts a parameter from a given object and returns it as 'index' value.
- * @function readXObjParamAsIndex
+ * Extracts a parameter from a given object and returns it as a string.
+ * @function readXObjParamEx
  * @param {object} obj - some object
+ * @param {object} [opt] - options
  * @param {string} [key] - some key
- * @returns {number}
+ * @returns {string}
  * @throws {TypeError} if `obj` param is not an object
+ * @todo [since `v0.2.1`] deprecate use of `opt` as `string`
  */
-function readXObjParamAsIndex(obj, key) {
+function readXObjParamEx(obj, opt, key) {
   let result = undefined;
   try {
     result = readXObjParamRaw(obj, key);
@@ -940,7 +955,14 @@ function readXObjParamAsIndex(obj, key) {
       }
     };
   };
-  return valueToIndex(result);
+  /** @type {OPT_valtostr} */
+  const _opt = isPlainObject(opt) ? opt : {
+    useTrim: false,
+    numberToString: true,
+    boolToString: true,
+    defValue: opt,
+  };
+  return readAsString(result, _opt);
 };
 
 /**
@@ -999,6 +1021,7 @@ function writeXObjParamAsBool(obj, value, defValue, key) {
   };
   return isSucceed;
 };
+module.exports.writeXObjParamAsBool = writeXObjParamAsBool;
 
 /**
  * Tries to convert a given value to a number and writes it as a parameter
@@ -1030,6 +1053,7 @@ function writeXObjParamAsNum(obj, value, defValue, key) {
   };
   return isSucceed;
 };
+module.exports.writeXObjParamAsNum = writeXObjParamAsNum;
 
 /**
  * Tries to convert a given value into an 'index' value and writes it
@@ -1060,6 +1084,7 @@ function writeXObjParamAsIndex(obj, value, key) {
   };
   return isSucceed;
 };
+module.exports.writeXObjParamAsIndex = writeXObjParamAsIndex;
 
 /**
  * Tries to convert a given value to a string and writes it
@@ -1159,6 +1184,7 @@ function readXObjAttrAsBool(obj, attr, defValue, key) {
   };
   return readAsBoolEx(result, defValue);
 };
+module.exports.readXObjAttrAsBool = readXObjAttrAsBool;
 
 /**
  * Extracts an attribute from a given object and returns it as a number.
@@ -1187,19 +1213,18 @@ function readXObjAttrAsNum(obj, attr, defValue, key) {
   };
   return readAsNumberEx(result, defValue);
 };
+module.exports.readXObjAttrAsNum = readXObjAttrAsNum;
 
 /**
- * Extracts an attribute from a given object and returns it as a string.
- * @function readXObjAttrEx
+ * Extracts an attribute from a given object and returns it as 'index' value.
+ * @function readXObjAttrAsIndex
  * @param {object} obj - some object
  * @param {string} attr - some attribute
- * @param {object} [opt] - options
  * @param {string} [key] - some key
- * @returns {string}
+ * @returns {number}
  * @throws {TypeError} if `obj` param is not an object
- * @todo [since `v0.2.1`] deprecate use of `opt` as `string`
  */
-function readXObjAttrEx(obj, attr, opt, key) {
+function readXObjAttrAsIndex(obj, attr, key) {
   let result = undefined;
   try {
     result = readXObjAttrRaw(obj, attr, key);
@@ -1213,26 +1238,22 @@ function readXObjAttrEx(obj, attr, opt, key) {
       }
     };
   };
-  /** @type {OPT_valtostr} */
-  const _opt = isPlainObject(opt) ? opt : {
-    useTrim: true,
-    numberToString: true,
-    boolToString: true,
-    defValue: opt,
-  };
-  return readAsString(result, _opt);
+  return valueToIndex(result);
 };
+module.exports.readXObjAttrAsIndex = readXObjAttrAsIndex;
 
 /**
- * Extracts an attribute from a given object and returns it as 'index' value.
- * @function readXObjAttrAsIndex
+ * Extracts an attribute from a given object and returns it as a string.
+ * @function readXObjAttrEx
  * @param {object} obj - some object
  * @param {string} attr - some attribute
+ * @param {object} [opt] - options
  * @param {string} [key] - some key
- * @returns {number}
+ * @returns {string}
  * @throws {TypeError} if `obj` param is not an object
+ * @todo [since `v0.2.1`] deprecate use of `opt` as `string`
  */
-function readXObjAttrAsIndex(obj, attr, key) {
+function readXObjAttrEx(obj, attr, opt, key) {
   let result = undefined;
   try {
     result = readXObjAttrRaw(obj, attr, key);
@@ -1246,7 +1267,14 @@ function readXObjAttrAsIndex(obj, attr, key) {
       }
     };
   };
-  return valueToIndex(result);
+  /** @type {OPT_valtostr} */
+  const _opt = isPlainObject(opt) ? opt : {
+    useTrim: true,
+    numberToString: true,
+    boolToString: true,
+    defValue: opt,
+  };
+  return readAsString(result, _opt);
 };
 
 /**
@@ -1307,6 +1335,7 @@ function writeXObjAttrAsBool(obj, attr, value, defValue, key) {
   };
   return isSucceed;
 };
+module.exports.writeXObjAttrAsBool = writeXObjAttrAsBool;
 
 /**
  * Tries to convert a given value to a number and writes it as an attribute
@@ -1339,6 +1368,7 @@ function writeXObjAttrAsNum(obj, attr, value, defValue, key) {
   };
   return isSucceed;
 };
+module.exports.writeXObjAttrAsNum = writeXObjAttrAsNum;
 
 /**
  * Tries to convert a given value into an 'index' value and writes it
@@ -1370,6 +1400,7 @@ function writeXObjAttrAsIndex(obj, attr, value, key) {
   };
   return isSucceed;
 };
+module.exports.writeXObjAttrAsIndex = writeXObjAttrAsIndex;
 
 /**
  * Tries to convert a given value to a string and writes it as an attribute
@@ -1604,28 +1635,16 @@ module.exports.clearXObjNode = clearXObjNode;
 
 module.exports.readXObjParamRaw = readXObjParamRaw;
 module.exports.readXObjParam = readXObjParam;
-module.exports.readXObjParamAsBool = readXObjParamAsBool;
-module.exports.readXObjParamAsNum = readXObjParamAsNum;
 module.exports.readXObjParamEx = readXObjParamEx;
-module.exports.readXObjParamAsIndex = readXObjParamAsIndex;
 module.exports.writeXObjParamRaw = writeXObjParamRaw;
 module.exports.writeXObjParam = writeXObjParam;
-module.exports.writeXObjParamAsBool = writeXObjParamAsBool;
-module.exports.writeXObjParamAsNum = writeXObjParamAsNum;
-module.exports.writeXObjParamAsIndex = writeXObjParamAsIndex;
 module.exports.writeXObjParamEx = writeXObjParamEx;
 
 module.exports.readXObjAttrRaw = readXObjAttrRaw;
 module.exports.readXObjAttr = readXObjAttr;
-module.exports.readXObjAttrAsBool = readXObjAttrAsBool;
-module.exports.readXObjAttrAsNum = readXObjAttrAsNum;
 module.exports.readXObjAttrEx = readXObjAttrEx;
-module.exports.readXObjAttrAsIndex = readXObjAttrAsIndex;
 module.exports.writeXObjAttrRaw = writeXObjAttrRaw;
 module.exports.writeXObjAttr = writeXObjAttr;
-module.exports.writeXObjAttrAsBool = writeXObjAttrAsBool;
-module.exports.writeXObjAttrAsNum = writeXObjAttrAsNum;
-module.exports.writeXObjAttrAsIndex = writeXObjAttrAsIndex;
 module.exports.writeXObjAttrEx = writeXObjAttrEx;
 
 module.exports.getXObjAttributes = getXObjAttributes;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ygracs/xobj-lib-js",
-  "version": "0.3.0-beta.0",
+  "version": "0.3.0",
   "description": "A helper library to work with xml-js module",
   "author": "ygracs <cs70th-om@rambler.ru>",
   "license": "MIT",