@ygracs/chn-alias-list 0.0.7 → 0.0.9

package/index.js

@@ -1,8 +1,18 @@
-// [v0.1.003-20260120]
+// [v0.2.004-20260628]
 
 // === module init block ===
 
-const lib = require('./lib/chn-alias-list');
+const {
+  TChnAliasItem, TChnAliasList,
+  // * import types definitions *
+  IChannelRecord,
+} = require('./lib/chn-alias-list');
+
+const {
+  TChnNameRecord, TChnNamesList,
+  // * import types definitions *
+  ILangTextPair,
+} = require('./lib/chn-names');
 
 const fileHelper = require('./lib/file-helper-ext');
 
@@ -17,10 +27,10 @@ const {
 
 // === module exports block ===
 
-module.exports.TChnNameRecord = lib.TChnNameRecord;
-module.exports.TChnNamesList = lib.TChnNamesList;
-module.exports.TChnAliasItem = lib.TChnAliasItem;
-module.exports.TChnAliasList = lib.TChnAliasList;
+module.exports.TChnNameRecord = TChnNameRecord;
+module.exports.TChnNamesList = TChnNamesList;
+module.exports.TChnAliasItem = TChnAliasItem;
+module.exports.TChnAliasList = TChnAliasList;
 
 module.exports.loadAliasFromFileSync = fileHelper.loadAliasFromFileSync;
 module.exports.saveAliasToFileSync = fileHelper.saveAliasToFileSync;
@@ -28,3 +38,5 @@ module.exports.saveAliasToFileSync = fileHelper.saveAliasToFileSync;
 // * export types definitions *
 // @ts-ignore
 module.exports.fsoDescr = fsoDescr;
+module.exports.ILangTextPair = ILangTextPair;
+module.exports.IChannelRecord = IChannelRecord;

package/lib/chn-alias-list.d.ts

@@ -13,12 +13,13 @@ export type IChannelRecord = {
     /**
      * - list of a channel names
      */
-    name: any[];
+    name: ILangTextPair[];
     /**
      * - channel status
      */
     status: string;
 };
+export const IChannelRecord: IChannelRecord;
 /**
  * A user defined procedure to process an array elements
  */
@@ -27,139 +28,9 @@ export type forEachProcEx = (item: any, index?: number, arr?: any[]) => void;
  * A user defined procedure to process an array elements
  */
 export type cbArrECheck = (item: any, index?: number, arr?: any[]) => any;
+import { ILangTextPair } from "./chn-names";
 
-/**
- * @classdesc This class implements an interface of the name record
- */
-export class TChnNameRecord {
-    /**
-     * Contains a language
-     */
-    get lang(): string;
-    /**
-     * Contains a value of the record
-     */
-    get text(): string;
-    /**
-     * Contains a value of the record
-     */
-    get value(): string[];
-    set value(data: string[]);
-    /**
-     * Sets the record value
-     */
-    setValue(data: any): boolean;
-    /**
-     * Returns value as a formated string
-     */
-    toFormatString(opt: any): string;
-    /**
-     * Clears the record
-     */
-    reset(): void;
-    #private;
-}
-
-/**
- * @classdesc This class implements an interface of the name records list
- */
-export class TChnNamesList {
-    /**
-     * Contains a quantity of a name records
-     */
-    get count(): number;
-    /**
-     * Contains a list of a name records
-     */
-    get value(): TChnNameRecord[];
-    /**
-     * Returns a flag whether a list is empty or not
-     */
-    isEmpty(): boolean;
-    /**
-     * Returns a flag whether a list has any members
-     */
-    isNotEmpty(): boolean;
-    /**
-     * Checks whether a given value is an index and fits an index range
-     * within the instance
-     */
-    chkIndex(value: any): boolean;
-    /**
-     * Searches an index of a given name
-     */
-    getIndex(value: string): number;
-    /**
-     * @deprecated
-     * @see TChnNamesList.getItem
-     * @todo [from v0.0.5] make obsolete
-     */
-    getName(value: any): TChnNameRecord;
-    /**
-     * Returns a name record
-     * @since 0.0.5
-     */
-    getItem(value: number): TChnNameRecord | null;
-    /**
-     * @deprecated
-     * @see TChnNamesList.addItem
-     * @todo [from v0.0.5] make obsolete
-     */
-    addName(data: any): boolean;
-    /**
-     * Adds a new name record to a list members
-     * @since 0.0.5
-     */
-    addItem(data: any): boolean;
-    /**
-     * @deprecated
-     * @see TChnNamesList.delItem
-     * @todo [from v0.0.5] make obsolete
-     */
-    delName(value: any): boolean;
-    /**
-     * Tries to delete a name record addressed by a given index
-     * @since 0.0.5
-     */
-    delItem(value: number): boolean;
-    /**
-     * @deprecated
-     * @see TChnNamesList.loadItems
-     * @todo [from v0.0.5] make obsolete
-     */
-    loadNames(...args: any[]): number;
-    /**
-     * Loads a new name records
-     * @since 0.0.5
-     */
-    loadItems(list: any, opt?: boolean): number;
-    /**
-     * Removes all of the instance members
-     */
-    clear(): void;
-    /**
-     * Calls given function for each name record
-     */
-    forEach(cb: forEachProcEx): void;
-    /**
-     * Returns an array of a  name records picked up by a given function
-     */
-    filter(cb: cbArrECheck): TChnNameRecord[];
-    [Symbol.iterator](): {
-        next: () => {
-            done: boolean;
-            value: TChnNameRecord | null;
-        } | {
-            done: boolean;
-            value?: undefined;
-        };
-        return(): {
-            done: boolean;
-        };
-    };
-    #private;
-}
-
+type loadItemsParams = Parameters<TChnNamesList["loadItems"]>;
 /**
  * @classdesc This class implements an interface of the channel item
  */
@@ -216,7 +87,7 @@ export class TChnAliasItem {
      * @see TChnNamesList.loadItems
      * @todo [from v0.0.7] deprecated. Use `TChnNamesList.loadItems` instead.
      */
-    loadNames(...args: [list: any, opt?: boolean]): number;
+    loadNames(...args: loadItemsParams): number;
     /**
      * Sets item status to enabled
      */
@@ -263,8 +134,22 @@ export class TChnAliasList {
     /**
      * Checks whether a given value is an index and fits an index range
      * within the instance
+     * @deprecated
+     * @todo \[since v0.0.9] deprecated. Use {@link checkIndex} instead.
      */
     chkIndex(value: any): boolean;
+    /**
+     * Checks whether a given value is an index and fits an index range
+     * within the instance
+     * @since 0.0.9
+     */
+    checkIndex(value: any): boolean;
+    /**
+     * Returns an index in case a given value is a valid index value and not exceeds
+     * an index range within the instance. If failed a `-1` returned
+     * @since 0.0.9
+     */
+    tryIndex(value: any): number;
     /**
      * Searches an index of an element by its ID
      * @see valueToIDString
@@ -289,7 +174,7 @@ export class TChnAliasList {
     /**
      * Loads a list of a new alias elements
      */
-    loadItems(list: IChannelRecord[], opt?: boolean): number;
+    loadItems(list: IChannelRecord[], opt?: boolean | ILoadListItemsOptions): number;
     /**
      * Removes all of the instance members
      */
@@ -316,3 +201,6 @@ export class TChnAliasList {
     };
     #private;
 }
+import { TChnNamesList } from "./chn-names";
+import { TChnNameRecord } from "./chn-names";
+import { ILoadListItemsOptions } from "./chn-names";