@ygracs/xobj-lib-js 0.3.0 → 0.3.2

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+#### *v0.3.2*
+
+Release version.
+
+> - some fixes.
+
+#### *v0.3.1*
+
+Release version.
+
+> - update dependency on `@ygracs/bsfoc-lib-js` module to v0.3.4.
+
 #### *v0.3.0*
 
 Release version.

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,

package/index.js

@@ -1,4 +1,4 @@
-// [v0.1.015-20260227]
+// [v0.1.016-20260530]
 
 // === 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;

package/lib/xObj-attr.d.ts

@@ -0,0 +1,97 @@
+/**
+ * Extracts an attributes from a given object by its key.
+ * @throws {TypeError} if `obj` param is not an object
+ */
+export function getXObjAttributes(obj: object, 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: object, 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: object, 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: object, 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: object, 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: object, 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: object, 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: object, attr: string, defValue?: boolean, key?: string): boolean;
+/**
+ * Extracts an attribute from a given object and returns it as a number.
+ * @returns {number}
+ * @throws {TypeError} if `obj` param is not an object
+ */
+export function readXObjAttrAsNum(obj: object, 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: object, 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: object, attr: string, opt?: object, 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: object, 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: object, 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: object, 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: 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.
+ * @throws {TypeError} if `obj` param is not an object
+ * @todo [since `v0.2.1`] deprecate use of `opt` as `string`
+ */
+export function writeXObjAttrEx(obj: object, attr: string, value: any, opt?: object, key?: string): boolean;
+import type { INode } from "./xObj-lib";