@ygracs/xobj-lib-js 0.3.1 → 0.3.3

package/CHANGELOG.md

@@ -1,3 +1,16 @@
+#### *v0.3.3*
+
+Release version.
+
+> - update `xObj.md`;
+> - some fixes.
+
+#### *v0.3.2*
+
+Release version.
+
+> - some fixes.
+
 #### *v0.3.1*
 
 Release version.

package/doc/xObj.md

@@ -1,6 +1,6 @@
->|***rev.*:**|0.1.52|
+>|***rev.*:**|0.1.53|
 >|:---|---:|
->|date:|2026-03-03|
+>|date:|2026-06-08|
 
 ## Introduction
 
@@ -13,6 +13,7 @@ This paper describes a functions provided by `xObj.js` module.
 - Base types
     - <a href="#typedef+xml2jsParseOptions">xml2jsParseOptions</a>
     - <a href="#typedef+js2xmlParseOptions">js2xmlParseOptions</a>
+    - <a href="#typedef+INode">INode</a>
 
 - Classes
     - <a href="#TXmlContentParseOptions">TXmlContentParseOptions</a>
@@ -28,6 +29,11 @@ This paper describes a functions provided by `xObj.js` module.
 
 This section contains some definitions for a general types of the objects (e.g. options set) that frequently used in a function descriptions.
 
+<a name="typedef+INode"></a>
+#### `INode` - object type
+
+This type is an `object` which represents a base element (so called an `XObj-node`). Its child elements addressed by a `key`. Each `key` is defined by a used parser options and must be a `string`.
+
 <a name="typedef+OPT_valtostr"></a>
 #### `OPT_valtostr` - options set
 
@@ -154,7 +160,7 @@ This function returns a value of an object parameter as a string.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `key` | `string` | --- | some key |
 
 ##### ***exceptions***
@@ -173,7 +179,7 @@ This function reads a value of an object parameter and returns it as a `boolean`
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `defValue` | `boolean` | `false` | default value |
 | `key` | `string` | --- | some key |
 
@@ -193,7 +199,7 @@ This function reads a value of an object parameter and returns it as a `number`.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `defValue` | `number` | `0` | default value |
 | `key` | `string` | --- | some key |
 
@@ -215,7 +221,7 @@ This function reads a value of an object parameter and try to convert it to a va
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `key` | `string` | --- | some key |
 
 ##### ***exceptions***
@@ -236,7 +242,7 @@ This function reads a value of an object parameter and returns it as a `string`.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `options` | `string`, `object` | --- | options that defines how a value must be transformed |
 | `key` | `string` | --- | some key |
 
@@ -279,7 +285,7 @@ This function sets object parameter to a given value and if succeed returns `tru
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `value` | `any` | --- | some value to write |
 | `key` | `string` | --- | some key |
 
@@ -299,7 +305,7 @@ This function writes a given `boolean` value of an object parameter.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `value` | `any` | --- | some value to write |
 | `defValue` | `boolean` | `false` | default value |
 | `key` | `string` | --- | some key |
@@ -320,7 +326,7 @@ This function writes a given `number` value of an object parameter.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `value` | `any` | --- | some value to write |
 | `defValue` | `number` | `0` | default value |
 | `key` | `string` | --- | some key |
@@ -341,7 +347,7 @@ This function try to interpret a given value as a valid index value and, if succ
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `value` | `any` | --- | some value to write |
 | `key` | `string` | --- | some key |
 
@@ -361,7 +367,7 @@ This function sets object parameter to a given value and if succeed returns `tru
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `value` | `any` | --- | some value to write |
 | `options` | `string`, `object` | --- | options that defines how a value must be transformed |
 | `key` | `string` | --- | some key |
@@ -405,7 +411,7 @@ This function returns a value of an object attribute. The value is of a `string`
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `key` | `string` | --- | some key |
 
@@ -425,7 +431,7 @@ This function reads a value of an object attribute and returns it as a `boolean`
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `defValue` | `boolean` | `false` | default value |
 | `key` | `string` | --- | some key |
@@ -446,7 +452,7 @@ This function reads a value of an object attribute and returns it as a `number`.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `defValue` | `number` | `0` | default value |
 | `key` | `string` | --- | some key |
@@ -469,7 +475,7 @@ This function reads a value of an object attribute and try to convert it to a va
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `key` | `string` | --- | some key |
 
@@ -491,7 +497,7 @@ This function returns a value of an object attribute. The value is of a `string`
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `options` | `string`, `object` | --- | options that defines how a value must be transformed |
 | `key` | `string` | --- | some key |
@@ -535,7 +541,7 @@ This function sets object attribute to a given value and if succeed returns `tru
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `value` | `any` | --- | some value |
 | `key` | `string` | --- | some key |
@@ -558,7 +564,7 @@ This function writes a given `boolean` value of an object attribute.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `value` | `any` | --- | some value |
 | `defValue` | `boolean` | `false` | default value |
@@ -580,7 +586,7 @@ This function writes a given `number` value of an object attribute.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `value` | `any` | --- | some value |
 | `defValue` | `number` | `0` | default value |
@@ -602,7 +608,7 @@ This function try to interpret a given value as a valid index value and, if succ
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `value` | `any` | --- | some value |
 | `key` | `string` | --- | some key |
@@ -623,7 +629,7 @@ This function sets object attribute to a given value and if succeed returns `tru
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `value` | `any` | --- | some value |
 | `options` | `string`, `object` | --- | options that defines how a value must be transformed |
@@ -664,7 +670,7 @@ This is a special function that returns a value of an object parameter as "IT IS
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `key` | `string` | --- | some key |
 
 > NOTE:
@@ -691,7 +697,7 @@ This is a special function that writes a given value of an object parameter as "
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `value` | `any` | --- | some value |
 | `key` | `string` | --- | some key |
 
@@ -722,7 +728,7 @@ This is a special function that returns a value of an object attribute as "IT IS
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `key` | `string` | --- | some key |
 
@@ -751,7 +757,7 @@ This is a special function that writes a given value of an object attribute as "
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `value` | `any` | --- | some value |
 | `key` | `string` | --- | some key |
@@ -779,7 +785,7 @@ The function throws a `EvalKeyNameError` exception in case:
 > If a `key` parameter given not given, the function will use a default value defined by `XOBJ_DEF_ATTR_TNAME`.
 
 <a name="getXObjAttributes"></a>
-#### **getXObjAttributes(object\[, key])** => `?object`
+#### **getXObjAttributes(object\[, key])** => `?INode`
 
 This function returns an object which represents a set of the element attributes for a given object or `null` if failed.
 
@@ -787,7 +793,7 @@ This function returns an object which represents a set of the element attributes
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `key` | `string` | --- | some key |
 
 ##### ***exceptions***
@@ -806,7 +812,7 @@ This function tries to check whether or not an attribute with a name given by `a
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `key` | `string` | --- | some key |
 
@@ -832,7 +838,7 @@ This function tries to delete  an attribute with a name given by `attr` paramete
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `key` | `string` | --- | some key |
 
@@ -860,7 +866,7 @@ This function tries to rename an attribute with a name given by `attr` parameter
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `attr` | `string` | --- | some attribute |
 | `value` | `string` | --- | new attribute ID |
 | `key` | `string` | --- | some key |
@@ -890,7 +896,7 @@ This function returns an element from a given object by its name or `null` if th
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `name` | `string` | --- | some child element ID |
 
 ##### ***exceptions***
@@ -937,7 +943,7 @@ This function adds an element given by `name` parameter to a members of the give
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `name` | `string` | --- | some child element ID |
 
 ##### ***result***
@@ -996,7 +1002,7 @@ This function inserts an empty element named by a `name` parameter into a given
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `name` | `string` | --- | some child element ID |
 | `options` | `object` | --- | options |
 
@@ -1063,7 +1069,7 @@ This function deletes an element addressed by `name` parameter from a given obje
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `name` | `string` | --- | some child element ID |
 
 ##### ***result***
@@ -1096,7 +1102,7 @@ This function renames an element addressed by `name` for the given object. If su
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `name` | `string` | --- | some child element ID |
 | `value` | `string` | --- | new element ID |
 
@@ -1124,7 +1130,7 @@ This function tries to clean a given node.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `node` | `object` or `object[]` | --- | some node |
+| `node` | `INode` or `INode[]` | --- | some node or nodes list |
 
 ##### ***exceptions***
 
@@ -1189,7 +1195,7 @@ This function inserts an elements list named by a `name` parameter into a given
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `object` | `object` | --- | some object |
+| `object` | `INode` | --- | some object |
 | `name` | `string` | --- | some child element ID |
 | `options` | `object` | --- | options |
 

package/index.d.ts

@@ -23,14 +23,6 @@ import { EvalKeyNameError } from "./lib/xObj-errors";
 export { EvalKeyNameError };
 
 import {
-    readXObjParamRaw,
-    readXObjParam,
-    readXObjParamEx,
-    readXObjParamAsBool, readXObjParamAsNum, readXObjParamAsIndex,
-    writeXObjParamRaw,
-    writeXObjParam,
-    writeXObjParamEx,
-    writeXObjParamAsBool, writeXObjParamAsNum, writeXObjParamAsIndex,
     readXObjAttrRaw,
     readXObjAttr,
     readXObjAttrEx,
@@ -43,6 +35,20 @@ import {
     checkXObjAttribute,
     deleteXObjAttribute,
     renameXObjAttribute,
+} from "./lib/xObj-attr";
+
+import {
+    readXObjParamRaw,
+    readXObjParam,
+    readXObjParamEx,
+    readXObjParamAsBool, readXObjParamAsNum, readXObjParamAsIndex,
+    writeXObjParamRaw,
+    writeXObjParam,
+    writeXObjParamEx,
+    writeXObjParamAsBool, writeXObjParamAsNum, writeXObjParamAsIndex,
+} from "./lib/xObj-param";
+
+import {
     getXObjElement,
     addXObjElement, addXObjElementEx,
     insertXObjElement, insertXObjElementEx,
@@ -98,6 +104,7 @@ import type {
     RVAL_emodif,
     VCOR_evalkname, RVAL_reason,
     IEvalKeyNameResult,
+    INode,
 } from "./lib/xObj-lib";
 
 export type {
@@ -106,4 +113,5 @@ export type {
     RVAL_emodif,
     VCOR_evalkname, RVAL_reason,
     IEvalKeyNameResult,
+    INode,
 };

package/index.js

@@ -1,4 +1,4 @@
-// [v0.1.015-20260227]
+// [v0.1.017-20260606]
 
 // === module init block ===
 
@@ -12,6 +12,10 @@ const {
   EvalKeyNameError,
 } = require('./lib/xObj-errors');
 
+const xObjAttr = require('./lib/xObj-attr');
+
+const xObjParam = require('./lib/xObj-param');
+
 const xObj = require('./lib/xObj-lib');
 
 // === module inner block ===
@@ -20,44 +24,42 @@ const xObj = require('./lib/xObj-lib');
 
 // === 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;
 
-module.exports.readXObjParamRaw = xObj.readXObjParamRaw;
-module.exports.readXObjParam = xObj.readXObjParam;
-module.exports.readXObjParamAsBool = xObj.readXObjParamAsBool;
-module.exports.readXObjParamAsNum = xObj.readXObjParamAsNum;
-module.exports.readXObjParamEx = xObj.readXObjParamEx;
-module.exports.readXObjParamAsIndex = xObj.readXObjParamAsIndex;
-module.exports.writeXObjParamRaw = xObj.writeXObjParamRaw;
-module.exports.writeXObjParam = xObj.writeXObjParam;
-module.exports.writeXObjParamAsBool = xObj.writeXObjParamAsBool;
-module.exports.writeXObjParamAsNum = xObj.writeXObjParamAsNum;
-module.exports.writeXObjParamAsIndex = xObj.writeXObjParamAsIndex;
-module.exports.writeXObjParamEx = xObj.writeXObjParamEx;
-
-module.exports.readXObjAttrRaw = xObj.readXObjAttrRaw;
-module.exports.readXObjAttr = xObj.readXObjAttr;
-module.exports.readXObjAttrAsBool = xObj.readXObjAttrAsBool;
-module.exports.readXObjAttrAsNum = xObj.readXObjAttrAsNum;
-module.exports.readXObjAttrEx = xObj.readXObjAttrEx;
-module.exports.readXObjAttrAsIndex = xObj.readXObjAttrAsIndex;
-module.exports.writeXObjAttrRaw = xObj.writeXObjAttrRaw;
-module.exports.writeXObjAttr = xObj.writeXObjAttr;
-module.exports.writeXObjAttrAsBool = xObj.writeXObjAttrAsBool;
-module.exports.writeXObjAttrAsNum = xObj.writeXObjAttrAsNum;
-module.exports.writeXObjAttrAsIndex = xObj.writeXObjAttrAsIndex;
-module.exports.writeXObjAttrEx = xObj.writeXObjAttrEx;
-
-module.exports.getXObjAttributes = xObj.getXObjAttributes;
-module.exports.checkXObjAttribute = xObj.checkXObjAttribute;
-module.exports.deleteXObjAttribute = xObj.deleteXObjAttribute;
-module.exports.renameXObjAttribute = xObj.renameXObjAttribute;
+module.exports.readXObjParamRaw = xObjParam.readXObjParamRaw;
+module.exports.readXObjParam = xObjParam.readXObjParam;
+module.exports.readXObjParamAsBool = xObjParam.readXObjParamAsBool;
+module.exports.readXObjParamAsNum = xObjParam.readXObjParamAsNum;
+module.exports.readXObjParamEx = xObjParam.readXObjParamEx;
+module.exports.readXObjParamAsIndex = xObjParam.readXObjParamAsIndex;
+module.exports.writeXObjParamRaw = xObjParam.writeXObjParamRaw;
+module.exports.writeXObjParam = xObjParam.writeXObjParam;
+module.exports.writeXObjParamAsBool = xObjParam.writeXObjParamAsBool;
+module.exports.writeXObjParamAsNum = xObjParam.writeXObjParamAsNum;
+module.exports.writeXObjParamAsIndex = xObjParam.writeXObjParamAsIndex;
+module.exports.writeXObjParamEx = xObjParam.writeXObjParamEx;
+
+module.exports.readXObjAttrRaw = xObjAttr.readXObjAttrRaw;
+module.exports.readXObjAttr = xObjAttr.readXObjAttr;
+module.exports.readXObjAttrAsBool = xObjAttr.readXObjAttrAsBool;
+module.exports.readXObjAttrAsNum = xObjAttr.readXObjAttrAsNum;
+module.exports.readXObjAttrEx = xObjAttr.readXObjAttrEx;
+module.exports.readXObjAttrAsIndex = xObjAttr.readXObjAttrAsIndex;
+module.exports.writeXObjAttrRaw = xObjAttr.writeXObjAttrRaw;
+module.exports.writeXObjAttr = xObjAttr.writeXObjAttr;
+module.exports.writeXObjAttrAsBool = xObjAttr.writeXObjAttrAsBool;
+module.exports.writeXObjAttrAsNum = xObjAttr.writeXObjAttrAsNum;
+module.exports.writeXObjAttrAsIndex = xObjAttr.writeXObjAttrAsIndex;
+module.exports.writeXObjAttrEx = xObjAttr.writeXObjAttrEx;
+
+module.exports.getXObjAttributes = xObjAttr.getXObjAttributes;
+module.exports.checkXObjAttribute = xObjAttr.checkXObjAttribute;
+module.exports.deleteXObjAttribute = xObjAttr.deleteXObjAttribute;
+module.exports.renameXObjAttribute = xObjAttr.renameXObjAttribute;
 
 module.exports.getXObjElement = xObj.getXObjElement;
 module.exports.addXObjElement = xObj.addXObjElement;
@@ -75,3 +77,5 @@ module.exports.insertXObjEListEx = xObj.insertXObjEListEx;
 module.exports.genXObjENameDescr = xObj.genXObjENameDescr;
 module.exports.insertXObjElements = xObj.insertXObjElements;
 module.exports.insertXObjEChain = xObj.insertXObjEChain;
+
+module.exports.INode = xObj.INode;

package/lib/xObj-attr.d.ts

@@ -0,0 +1,109 @@
+/**
+ * @deprecated
+ * @todo \[since `v0.2.1`] deprecated and will be removed
+ */
+export type readXObjAttrOptionAsStr = string;
+export const readXObjAttrOptionAsStr: readXObjAttrOptionAsStr;
+/**
+ * @deprecated
+ * @todo \[since `v0.2.1`] deprecated and will be removed
+ */
+export type writeXObjAttrOptionAsStr = string;
+export const writeXObjAttrOptionAsStr: writeXObjAttrOptionAsStr;
+/**
+ * Extracts an attributes from a given object by its key.
+ * @throws {TypeError} if `obj` param is not an object
+ */
+export function getXObjAttributes(obj: INode, key?: string): INode | null;
+/**
+ * Checks whether an attribute is exists.
+ * @throws {TypeError} if `obj` param is not an object
+ * @throws {EvalKeyNameError} if `attr` param is not valid identifier
+ */
+export function checkXObjAttribute(obj: INode, attr?: string, key?: string): boolean;
+/**
+ * Deletes an attribute addressed by a given name.
+ * @throws {TypeError} if `obj` param is not an object
+ * @throws {EvalKeyNameError} if `attr` param is not valid identifier
+ */
+export function deleteXObjAttribute(obj: INode, attr?: string, key?: string): boolean;
+/**
+ * Renames an attribute addressed by a given name.
+ * @since 0.2.0
+ * @throws {TypeError} if `obj` param is not an object
+ * @throws {EvalKeyNameError} if `attr` param is not valid identifier
+ * @throws {EvalKeyNameError} if `value` param is not valid identifier
+ * @throws {EvalKeyNameError} if `key` param is not valid identifier
+ */
+export function renameXObjAttribute(obj: INode, attr?: string, value?: string, key?: string): boolean;
+/**
+ * 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 readXObjAttrRaw(obj: INode, attr?: string, key?: string): any;
+/**
+ * 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 writeXObjAttrRaw(obj: INode, attr: string, value: any, key?: string): boolean;
+/**
+ * Extracts an attribute from a given object and returns it as a string.
+ * @throws {TypeError} if `obj` param is not an object
+ */
+export function readXObjAttr(obj: INode, attr: string, key?: string): string;
+/**
+ * Extracts an attribute from a given object and returns it as a boolean.
+ * @throws {TypeError} if `obj` param is not an object
+ */
+export function readXObjAttrAsBool(obj: INode, attr: string, defValue?: boolean, key?: string): boolean;
+/**
+ * Extracts an attribute from a given object and returns it as a number.
+ * @throws {TypeError} if `obj` param is not an object
+ */
+export function readXObjAttrAsNum(obj: INode, attr: string, defValue?: number, key?: string): number;
+/**
+ * Extracts an attribute from a given object and returns it as 'index' value.
+ * @throws {TypeError} if `obj` param is not an object
+ */
+export function readXObjAttrAsIndex(obj: INode, attr: string, key?: string): number;
+/**
+ * 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 readXObjAttrEx(obj: INode, attr: string, opt?: readXObjAttrOptionAsStr | IValueToStringTransformOptions, key?: string): string;
+/**
+ * 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 writeXObjAttr(obj: INode, attr: string, value: any, key?: string): boolean;
+/**
+ * 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 writeXObjAttrAsBool(obj: INode, attr: string, value: any, defValue?: boolean, key?: string): boolean;
+/**
+ * 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 writeXObjAttrAsNum(obj: INode, attr: string, value: any, defValue?: number, key?: string): boolean;
+/**
+ * Tries to convert a given value into an 'index' value and writes it
+ * as an attribute into a given object.
+ * @throws {TypeError} if `obj` param is not an object
+ */
+export function writeXObjAttrAsIndex(obj: INode, 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.
+ * @throws {TypeError} if `obj` param is not an object
+ * @todo [since `v0.2.1`] deprecate use of `opt` as `string`
+ */
+export function writeXObjAttrEx(obj: INode, attr: string, value: any, opt?: writeXObjAttrOptionAsStr | IValueToStringTransformOptions, key?: string): boolean;
+import type { INode } from "./xObj-lib";
+import type { IValueToStringTransformOptions } from "@ygracs/bsfoc-lib-js";