@ygracs/chn-alias-list 0.0.7-b → 0.0.8

package/CHANGELOG.md

@@ -1,9 +1,21 @@
-#### *v0.0.x*
+#### *v0.0.8*
 
 Pre-release version.
 
+> - update dependency on `@ygracs/bsfoc-lib-js` module to v0.3.4;
+> - (TChnNamesList) remove deprecated method: `getName`, `addName`, `delName`, `loadNames`;
+> - some fixes.
+
+#### *v0.0.7*
+
+Pre-release version.
+
+> - update `chn-alias-list.md`;
 > - update dependency on `@ygracs/bsfoc-lib-js` module to v0.3.3;
 > - update dependency on `@cntwg/file-helper` module to v0.0.3;
+> - improve behavior of `saveAliasToFileSync` on handling `content` param;
+> - deprecate methods: `addName` and `loadNames` of a `TChnAliasItem`-class;
+> - other fixes.
 
 #### *v0.0.6*
 

package/doc/chn-alias-list.md

@@ -1,7 +1,7 @@
 
->|***rev.*:**|0.0.5|
+>|***rev.*:**|0.0.9|
 >|:---|---:|
->|date:|2025-04-14|
+>|date:|2026-03-08|
 
 ## Introduction
 
@@ -9,6 +9,10 @@ This paper describes a classes and some helper functions provided by `chn-alias-
 
 ## Content
 
+- Base types
+    - <a href="#typedef+IChannelRecord">IChannelRecord</a>
+    - <a href="#typedef+fsoDescr">fsoDescr</a>
+
 - Classes
     - <a href="#TChnNameRecord">TChnNameRecord</a>
     - <a href="#TChnNamesList">TChnNamesList</a>
@@ -19,6 +23,36 @@ This paper describes a classes and some helper functions provided by `chn-alias-
     - <a href="#loadAliasFromFileSync">loadAliasFromFileSync</a>
     - <a href="#saveAliasToFileSync">saveAliasToFileSync</a>
 
+### Base type definitions
+
+This section contains some definitions for a general types of the objects (e.g. options set) that frequently used in a function or a class method descriptions.
+
+<a name="typedef+IChannelRecord"></a>
+#### `IChannelRecord` - descriptor
+
+This descriptor is an `object` that contains an info of a channel data.
+
+| property name | value type | optional | description |
+|:---|---|---:|:---|
+| `id` | `string` | no | a channel ID |
+| `alias` | `string` | no | a target ID for a channel |
+| `name` | `any[]` | no | a list of a channel names |
+| `status` | `string` | no | a channel status |
+
+<a name="typedef+fsoDescr"></a>
+#### `fsoDescr` - descriptor
+
+This descriptor is an `object` that describes a status for an operation with some FS-object (*e.g. object such as a file*).
+
+| property name | value type | optional | description |
+|:---|---|---:|:---|
+| `isERR` | `boolean` | no | a flag which indicates whether an error was happen |
+| `errCode` | `number` | yes | an error code |
+| `errEvent` | `string` | no | an error event identifier |
+| `errMsg` | `string` | yes | an error message |
+| `source` | `string` | yes | path to a file |
+| `content` | `any` | yes | content |
+
 ## Module classes
 
 <a name="TChnNameRecord"></a>
@@ -52,7 +86,7 @@ The class constructor creates a new instance of the class. It receives no argume
 
 | value type | read only | description |
 |---|---|:---|
-| `array` | no | defines a value of a name record |
+| `string[]` | no | defines a value of a name record |
 
 #### class methods
 
@@ -103,7 +137,7 @@ The class constructor creates a new instance of the class. It receives no argume
 
 | value type | read only | description |
 |---|---|:---|
-| `array` | yes | contains a list of a name records |
+| `TChnNameRecord[]` | yes | contains a list of a name records |
 
 #### class methods
 
@@ -135,11 +169,6 @@ Searches an index of a given name in the list.
 |:---|---|---:|:---|
 | `value` | `string` | --- | a name to be searched |
 
-<a name="TChnNamesList+getName"></a>
-##### **getName(value)** => `?TChnNameRecord`
-
-> \[!] NOTE: `[since v0.0.5]` deprecated. Use `getItem` instead.
-
 <a name="TChnNamesList+getItem"></a>
 ##### **getItem(value)** => `?TChnNameRecord`
 
@@ -151,11 +180,6 @@ Returns a name record addressed by a given index.
 |:---|---|---:|:---|
 | `value` | `number` | --- | an element index in the list |
 
-<a name="TChnNamesList+addName"></a>
-#### **addName(data)** => `boolean`
-
-> \[!] NOTE: `[since v0.0.5]` deprecated. Use `addItem` instead.
-
 <a name="TChnNamesList+addItem"></a>
 #### **addItem(data)** => `boolean`
 
@@ -167,11 +191,6 @@ Adds a new name record to a list members.
 |:---|---|---:|:---|
 | `data` | `any` | --- | a data for a name record to be added in the list |
 
-<a name="TChnNamesList+delName"></a>
-##### **delName(value)** => `boolean`
-
-> \[!] NOTE: `[since v0.0.5]` deprecated. Use `delItem` instead.
-
 <a name="TChnNamesList+delItem"></a>
 ##### **delItem(value)** => `boolean`
 
@@ -183,11 +202,6 @@ Tries to delete a name record addressed by a given index.
 |:---|---|---:|:---|
 | `value` | `number` | --- | an element index in the list |
 
-<a name="TChnNamesList+loadNames"></a>
-##### **loadNames(list, \[opt])** => `number`
-
-> \[!] NOTE: `[since v0.0.5]` deprecated. Use `loadItems` instead.
-
 <a name="TChnNamesList+loadItems"></a>
 ##### **loadItems(list, \[opt])** => `number`
 
@@ -288,16 +302,12 @@ Sets a channel alias.
 <a name="TChnAliasItem+addName"></a>
 ##### **addName(data)** => `boolean`
 
-Adds a new name record.
-
-> **See**: [TChnNamesList.addName](#TChnNamesList+addName)
+> \[!] NOTE: `[since v0.0.7]` deprecated. Use [`TChnNamesList.addItem`](#TChnNamesList+addItem) instead.
 
 <a name="TChnAliasItem+loadNames"></a>
 ##### **loadNames(list, \[opt])** => `number`
 
-Loads a list of a new name records.
-
-> **See**: [TChnNamesList.loadNames](#TChnNamesList+loadNames)
+> \[!] NOTE: `[since v0.0.7]` deprecated. Use [`TChnNamesList.loadItems`](#TChnNamesList+loadItems) instead.
 
 <a name="TChnAliasItem+enable"></a>
 ##### **enable()** => `void`
@@ -333,7 +343,7 @@ Sets item status.
 #### class methods (*special*)
 
 <a name="TChnAliasItem+toJSON"></a>
-##### **toJSON()**
+##### **toJSON()** => `IChannelRecord`
 
 A special method that provides an interface to an instance representation
 for a `JSON.stringify()`.
 
@@ -346,7 +356,7 @@ Creates a new alias element.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `obj` | `object` | --- | an initial data |
+| `obj` | `IChannelRecord` | --- | an initial data |
 
 <a name="TChnAliasList"></a>
 ### **TChnAliasList**
@@ -423,7 +433,7 @@ Adds an alias element.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `obj` | `object` | --- | an element to be added |
+| `obj` | `IChannelRecord` | --- | an element to be added |
 
 <a name="TChnAliasList+delItem"></a>
 ##### **delItem(value)** => `boolean`
@@ -441,7 +451,7 @@ Loads a list of a new alias elements.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
-| `list` | `array` | --- | a list of an elements |
+| `list` | `IChannelRecord[]` | --- | a list of an elements |
 | `opt` | `boolean` | `true` | a flag that defines whether to clear the list before load a new one |
 
 <a name="TChnAliasList+clear"></a>
@@ -474,7 +484,7 @@ Returns an array of a channel items picked up by a given function.
 <a name="loadAliasFromFileSync"></a>
 #### **loadAliasFromFileSync(src, [opt])** => `object`
 
-Loads an alias from a file.
+Loads an alias data from a file.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
@@ -482,12 +492,12 @@ Loads an alias from a file.
 | `opt` | `any` | --- | <*reserved*> |
 
 <a name="saveAliasToFileSync"></a>
-#### **saveAliasToFileSync(src, content, [opt])** => `object`
+#### **saveAliasToFileSync(src, content, [opt])** => `fsoDescr`
 
-Saves an alias to a file
+Saves an alias data to a file.
 
 | parameter name | value type | default value | description |
 |:---|---|---:|:---|
 | `src` | `string` | --- | a path to some file |
-| `content` | `array` | --- | a content to save |
+| `content` | `object` or `object[]` | --- | a content to save |
 | `opt` | `any` | --- | <*reserved*> |

package/index.d.ts

@@ -1,17 +1,24 @@
-import {
-  TChnNameRecord, TChnNamesList,
-  TChnAliasItem, TChnAliasList,
-} from './lib/chn-alias-list';
-
-import {
-  loadAliasFromFileSync, saveAliasToFileSync,
-} from './lib/file-helper-ext';
-
-export {
-  TChnNameRecord, TChnNamesList,
-  TChnAliasItem, TChnAliasList,
-  loadAliasFromFileSync, saveAliasToFileSync,
-};
-
-import type { fsoDescr } from '@cntwg/file-helper';
-export type { fsoDescr };
+import type { fsoDescr } from '@cntwg/file-helper';
+
+import {
+  TChnNameRecord, TChnNamesList,
+  TChnAliasItem, TChnAliasList,
+  type IChannelRecord,
+} from './lib/chn-alias-list';
+
+import {
+  loadAliasFromFileSync, saveAliasToFileSync,
+  type RVAL_loadaliasff,
+} from './lib/file-helper-ext';
+
+export {
+  TChnNameRecord, TChnNamesList,
+  TChnAliasItem, TChnAliasList,
+  loadAliasFromFileSync, saveAliasToFileSync,
+};
+
+export type {
+  fsoDescr,
+  IChannelRecord,
+  RVAL_loadaliasff,
+};

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

@@ -1,292 +1,294 @@
-/**
- * A user defined procedure to process an array elements
- */
-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;
-
-/**
- * @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;
-}
-
-/**
- * @classdesc This class implements an interface of the channel item
- */
-export class TChnAliasItem {
-    /**
-     * Creates a new alias element
-     */
-    static create(obj: object): TChnAliasItem | null;
-    /**
-     * Contains a channel ID
-     */
-    get id(): string;
-    set id(value: string);
-    /**
-     * Contains a channel alias
-     */
-    get alias(): string;
-    set alias(value: string);
-    /**
-     * Contains a list of a name records
-     */
-    get names(): TChnNamesList;
-    /**
-     * Contains an instance status
-     */
-    get status(): string;
-    /**
-     * Sets a channel ID
-     * @see valueToIDString
-     */
-    setID(value: string): boolean;
-    /**
-     * Sets a channel alias
-     * @see valueToIDString
-     */
-    setAlias(value: string): boolean;
-    /**
-     * Returns a name record
-     * @deprecated
-     * @see TChnNamesList.getItem
-     */
-    getName(value: number): TChnNameRecord | null;
-    /**
-     * Adds a new name record
-     * @see TChnNamesList.addItem
-     */
-    addName(data: any): boolean;
-    /**
-     * Loads a list of a new name records
-     * @see TChnNamesList.loadItems
-     */
-    loadNames(...args: [list: any, opt?: boolean]): number;
-    /**
-     * Sets item status to enabled
-     */
-    enable(): void;
-    /**
-     * Sets item status to disabled
-     */
-    disable(): void;
-    /**
-     * Sets item status to active/running
-     */
-    up(): void;
-    /**
-     * Sets item status to inactive/stopped
-     */
-    down(): void;
-    /**
-     * Sets item status
-     */
-    setStatus(value: string): boolean;
-    /**
-     * Provides an interface to an instance representation for JSON.stringify()
-     */
-    protected toJSON(): any;
-    #private;
-}
-
-/**
- * @classdesc This class implements an interface of the channel items list
- */
-export class TChnAliasList {
-    /**
-     * Contains a quantity of the elements
-     */
-    get count(): number;
-    /**
-     * 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 an element by its ID
-     * @see valueToIDString
-     */
-    searchIndexByID(value: string): number;
-    /**
-     * Returns an alias element by its index
-     */
-    getItem(value: number): TChnAliasItem | null;
-    /**
-     * Returns an alias element by its ID
-     */
-    getItemByID(value: string): TChnAliasItem | null;
-    /**
-     * Adds an alias element
-     */
-    addItem(obj: object): number;
-    /**
-     * Tries to delete an element addressed by a given index
-     */
-    delItem(value: number): boolean;
-    /**
-     * Loads a list of a new alias elements
-     */
-    loadItems(list: any[], opt?: boolean): number;
-    /**
-     * Removes all of the instance members
-     */
-    clear(): void;
-    /**
-     * Calls given function for each alias element
-     */
-    forEach(cb: forEachProcEx): void;
-    /**
-     * Returns an array of a  name records picked up by a given function
-     */
-    filter(cb: cbArrECheck): TChnAliasItem[];
-    [Symbol.iterator](): {
-        next: () => {
-            done: boolean;
-            value: TChnAliasItem | null;
-        } | {
-            done: boolean;
-            value?: undefined;
-        };
-        return(): {
-            done: boolean;
-        };
-    };
-    #private;
-}
+/**
+ * Defines an object for storing a channel data
+ */
+export type IChannelRecord = {
+    /**
+     * - channel ID
+     */
+    id: string;
+    /**
+     * - target ID
+     */
+    alias: string;
+    /**
+     * - list of a channel names
+     */
+    name: any[];
+    /**
+     * - channel status
+     */
+    status: string;
+};
+/**
+ * A user defined procedure to process an array elements
+ */
+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;
+
+/**
+ * @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;
+    /**
+     * Returns a name record
+     * @since 0.0.5
+     */
+    getItem(value: number): TChnNameRecord | null;
+    /**
+     * Adds a new name record to a list members
+     * @since 0.0.5
+     */
+    addItem(data: any): boolean;
+    /**
+     * Tries to delete a name record addressed by a given index
+     * @since 0.0.5
+     */
+    delItem(value: number): boolean;
+    /**
+     * 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;
+}
+
+/**
+ * @classdesc This class implements an interface of the channel item
+ */
+export class TChnAliasItem {
+    /**
+     * Creates a new alias element
+     */
+    static create(obj: IChannelRecord): TChnAliasItem | null;
+    /**
+     * Contains a channel ID
+     */
+    get id(): string;
+    set id(value: string);
+    /**
+     * Contains a channel alias
+     */
+    get alias(): string;
+    set alias(value: string);
+    /**
+     * Contains a list of a name records
+     */
+    get names(): TChnNamesList;
+    /**
+     * Contains an instance status
+     */
+    get status(): string;
+    /**
+     * Sets a channel ID
+     * @see valueToIDString
+     */
+    setID(value: string): boolean;
+    /**
+     * Sets a channel alias
+     * @see valueToIDString
+     */
+    setAlias(value: string): boolean;
+    /**
+     * Returns a name record
+     * @deprecated
+     * @see TChnNamesList.getItem
+     * @todo [from v0.0.6] make obsolete
+     */
+    getName(value: number): TChnNameRecord | null;
+    /**
+     * Adds a new name record
+     * @deprecated
+     * @see TChnNamesList.addItem
+     * @todo [from v0.0.7] deprecated. Use `TChnNamesList.addItem` instead.
+     */
+    addName(data: any): boolean;
+    /**
+     * Loads a list of a new name records
+     * @deprecated
+     * @see TChnNamesList.loadItems
+     * @todo [from v0.0.7] deprecated. Use `TChnNamesList.loadItems` instead.
+     */
+    loadNames(...args: [list: any, opt?: boolean]): number;
+    /**
+     * Sets item status to enabled
+     */
+    enable(): void;
+    /**
+     * Sets item status to disabled
+     */
+    disable(): void;
+    /**
+     * Sets item status to active/running
+     */
+    up(): void;
+    /**
+     * Sets item status to inactive/stopped
+     */
+    down(): void;
+    /**
+     * Sets item status
+     */
+    setStatus(value: string): boolean;
+    /**
+     * Provides an interface to an instance representation for JSON.stringify()
+     */
+    protected toJSON(): IChannelRecord;
+    #private;
+}
+
+/**
+ * @classdesc This class implements an interface of the channel items list
+ */
+export class TChnAliasList {
+    /**
+     * Contains a quantity of the elements
+     */
+    get count(): number;
+    /**
+     * 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 an element by its ID
+     * @see valueToIDString
+     */
+    searchIndexByID(value: string): number;
+    /**
+     * Returns an alias element by its index
+     */
+    getItem(value: number): TChnAliasItem | null;
+    /**
+     * Returns an alias element by its ID
+     */
+    getItemByID(value: string): TChnAliasItem | null;
+    /**
+     * Adds an alias element
+     */
+    addItem(obj: IChannelRecord): number;
+    /**
+     * Tries to delete an element addressed by a given index
+     */
+    delItem(value: number): boolean;
+    /**
+     * Loads a list of a new alias elements
+     */
+    loadItems(list: IChannelRecord[], opt?: boolean): number;
+    /**
+     * Removes all of the instance members
+     */
+    clear(): void;
+    /**
+     * Calls given function for each alias element
+     */
+    forEach(cb: forEachProcEx): void;
+    /**
+     * Returns an array of a  name records picked up by a given function
+     */
+    filter(cb: cbArrECheck): TChnAliasItem[];
+    [Symbol.iterator](): {
+        next: () => {
+            done: boolean;
+            value: TChnAliasItem | null;
+        } | {
+            done: boolean;
+            value?: undefined;
+        };
+        return(): {
+            done: boolean;
+        };
+    };
+    #private;
+}

package/lib/chn-alias-list.js

@@ -1,4 +1,4 @@
-// [v0.1.047-20260120]
+// [v0.1.053-20260308]
 
 // === module init block ===
 
@@ -10,10 +10,6 @@ const {
 
 // === module inner block ===
 
-/***
- * (* helper function definitions *)
- */
-
 /**
  * Converts a <Lang, Text> key-pair to a string
  * @function convertLangTextValueToString
@@ -37,16 +33,13 @@ function convertLangTextValueToString(data, opt) {
 
 // === module main block ===
 
-/***
- * (* constant definitions *)
- */
-
-/***
- * (* function definitions *)
- */
-
-/***
- * (* class definitions *)
+/**
+ * Defines an object for storing a channel data
+ * @typedef {Object} IChannelRecord
+ * @property {string} id - channel ID
+ * @property {string} alias - target ID
+ * @property {any[]} name - list of a channel names
+ * @property {string} status - channel status
  */
 
 /**
@@ -152,6 +145,7 @@ class TChnNameRecord {
   }
 
 };
+module.exports.TChnNameRecord = TChnNameRecord;
 
 /**
  * A user defined procedure to process an array elements
@@ -265,15 +259,6 @@ class TChnNamesList {
     return index;
   }
 
-  /**
-   * @deprecated
-   * @see TChnNamesList.getItem
-   * @todo [from v0.0.5] make obsolete
-   */
-  getName(value) {
-    return this.getItem(value);
-  }
-
   /**
    * Returns a name record
    * @since 0.0.5
@@ -284,15 +269,6 @@ class TChnNamesList {
     return this.chkIndex(value) ? this.#_items[Number(value)] : null;
   }
 
-  /**
-   * @deprecated
-   * @see TChnNamesList.addItem
-   * @todo [from v0.0.5] make obsolete
-   */
-  addName(data) {
-    return this.addItem(data);
-  }
-
   /**
    * Adds a new name record to a list members
    * @since 0.0.5
@@ -307,15 +283,6 @@ class TChnNamesList {
     return isSucceed;
   }
 
-  /**
-   * @deprecated
-   * @see TChnNamesList.delItem
-   * @todo [from v0.0.5] make obsolete
-   */
-  delName(value) {
-    return this.delItem(value);
-  }
-
   /**
    * Tries to delete a name record addressed by a given index
    * @since 0.0.5
@@ -328,15 +295,6 @@ class TChnNamesList {
     return isSucceed;
   }
 
-  /**
-   * @deprecated
-   * @see TChnNamesList.loadItems
-   * @todo [from v0.0.5] make obsolete
-   */
-  loadNames(...args) {
-    return this.loadItems(...args);
-  }
-
   /**
    * Loads a new name records
    * @since 0.0.5
@@ -382,6 +340,7 @@ class TChnNamesList {
   }
 
 };
+module.exports.TChnNamesList = TChnNamesList;
 
 /**
  * @classdesc This class implements an interface of the channel item
@@ -490,6 +449,7 @@ class TChnAliasItem {
    * @returns {?TChnNameRecord}
    * @deprecated
    * @see TChnNamesList.getItem
+   * @todo [from v0.0.6] make obsolete
    */
   getName(value) {
     return this.#_names.getItem(value);
@@ -499,7 +459,9 @@ class TChnAliasItem {
    * Adds a new name record
    * @param {any} data - a name record
    * @returns {boolean}
+   * @deprecated
    * @see TChnNamesList.addItem
+   * @todo [from v0.0.7] deprecated. Use `TChnNamesList.addItem` instead.
    */
   addName(data) {
     return this.#_names.addItem(data);
@@ -510,7 +472,9 @@ class TChnAliasItem {
    * @param {array} list - a list of an elements
    * @param {boolean} [opt=true] - defines whether to clear the list before load a new one
    * @returns {number}
+   * @deprecated
    * @see TChnNamesList.loadItems
+   * @todo [from v0.0.7] deprecated. Use `TChnNamesList.loadItems` instead.
    */
   loadNames(...args) {
     return this.#_names.loadItems(...args);
@@ -582,7 +546,7 @@ class TChnAliasItem {
 
   /**
    * Provides an interface to an instance representation for JSON.stringify()
-   * @returns {Object}
+   * @returns {IChannelRecord}
    * @protected
    */
   toJSON() {
@@ -597,7 +561,7 @@ class TChnAliasItem {
 
   /**
    * Creates a new alias element
-   * @param {object} obj - an init data
+   * @param {IChannelRecord} obj - an init data
    * @returns {?TChnAliasItem}
    * @static
    */
@@ -610,7 +574,7 @@ class TChnAliasItem {
         let { alias, name, status } = obj;
         if (obj instanceof TChnAliasItem) name = obj.names.value;
         item.setAlias(alias);
-        item.loadNames(name);
+        item.names.loadItems(name);
         if (typeof isDisabled === 'boolean') {
           // // TODO: process "status"
           if (isDisabled) item.disable();
@@ -624,6 +588,7 @@ class TChnAliasItem {
   }
 
 };
+module.exports.TChnAliasItem = TChnAliasItem;
 
 /**
  * @classdesc This class implements an interface of the channel items list
@@ -726,7 +691,7 @@ class TChnAliasList {
 
   /**
    * Adds an alias element
-   * @param {object} obj - an element to be added
+   * @param {IChannelRecord} obj - an element to be added
    * @returns {number}
    */
   addItem(obj) {
@@ -734,7 +699,7 @@ class TChnAliasList {
     let index = -1;
     if (item !== null) {
       const id = valueToIDString(item.id);
-      index = this.searchIndexByID(id);
+      if (id != null) index = this.searchIndexByID(id);
       if (index === -1) {
         index = this.count;
         this.#_items.push(item);
@@ -758,7 +723,7 @@ class TChnAliasList {
 
   /**
    * Loads a list of a new alias elements
-   * @param {array} list - a list of an elements
+   * @param {IChannelRecord[]} list - a list of an elements
    * @param {boolean} [opt=true] - defines whether to clear the list before load a new one
    * @returns {number}
    */
@@ -799,10 +764,4 @@ class TChnAliasList {
   }
 
 };
-
-// === module exports block ===
-
-module.exports.TChnNameRecord = TChnNameRecord;
-module.exports.TChnNamesList = TChnNamesList;
-module.exports.TChnAliasItem = TChnAliasItem;
 module.exports.TChnAliasList = TChnAliasList;

package/lib/file-helper-ext.d.ts

@@ -1,28 +1,28 @@
-/**
- * A result of `loadAliasFromFile...`
- */
-export type RVAL_loadaliasff = {
-    /**
-     * - ops description
-     */
-    descr: fsoDescr;
-    /**
-     * - loaded content
-     */
-    result: null | TChnAliasItem | TChnAliasList;
-};
-
-/**
- * Loads an alias from a file
- * @see {@link loadJSONFromFileSync} for details of an `opt` param
- */
-export function loadAliasFromFileSync(src: string, opt?: any): RVAL_loadaliasff;
-/**
- * Saves an alias to a file
- * @see {@link saveJSONToFileSync} for details of an `opt` param
- */
-export function saveAliasToFileSync(src: string, content: any[], opt?: any): fsoDescr;
-
-import type { fsoDescr } from '@cntwg/file-helper';
-import { TChnAliasItem } from "./chn-alias-list";
-import { TChnAliasList } from "./chn-alias-list";
+/**
+ * A result of `loadAliasFromFile...`
+ */
+export type RVAL_loadaliasff = {
+    /**
+     * - ops description
+     */
+    descr: fsoDescr;
+    /**
+     * - loaded content
+     */
+    result: null | TChnAliasItem | TChnAliasList;
+};
+
+/**
+ * Loads an alias from a file
+ * @see {@link loadJSONFromFileSync} for details of an `opt` param
+ */
+export function loadAliasFromFileSync(src: string, opt?: any): RVAL_loadaliasff;
+/**
+ * Saves an alias to a file
+ * @see {@link saveJSONToFileSync} for details of an `opt` param
+ */
+export function saveAliasToFileSync(src: string, content: object | object[], opt?: any): fsoDescr;
+
+import type { fsoDescr } from "@cntwg/file-helper";
+import { TChnAliasItem } from "./chn-alias-list";
+import { TChnAliasList } from "./chn-alias-list";

package/lib/file-helper-ext.js

@@ -1,9 +1,9 @@
-// [v0.1.047-20260120]
+// [v0.1.050-20260308]
 
 // === module init block ===
 
 const {
-  isArray,
+  isArray, isObject,
 } = require('@ygracs/bsfoc-lib-js');
 
 const {
@@ -21,14 +21,6 @@ const {
 
 // === module main block ===
 
-/***
- * (* constant definitions *)
- */
-
-/***
- * (* function definitions *)
- */
-
 /**
  * A result of `loadAliasFromFile...`
  * @typedef {Object} RVAL_loadaliasff
@@ -58,29 +50,38 @@ function loadAliasFromFileSync(src, opt) {
   };
   return { descr, result };
 };
+module.exports.loadAliasFromFileSync = loadAliasFromFileSync;
 
 /**
  * Saves an alias to a file
  * @function saveAliasToFileSync
  * @param {string} src - a path to some file
- * @param {Array} content - content
+ * @param {(object|object[])} content - content
  * @param {any} [opt] - <reserved>
  * @returns {fsoDescr}
  * @see {@link saveJSONToFileSync} for details of an `opt` param
  */
 function saveAliasToFileSync(src, content, opt) {
-  const obj = isArray(content) ? content : null;
-  let result = null;
-  //===
-  result = saveJSONToFileSync(src, obj, opt);
-  return result;
+  /** @type {fsoDescr} */
+  let data = {
+    isERR: false,
+    errCode: 0,
+    errEvent: '',
+    errMsg: '',
+    source: '',
+    content: '',
+  };
+  if (isArray(content) || isObject(content)) {
+    //const obj = isArray(content) ? content : null;
+    //===
+    data = saveJSONToFileSync(src, content, opt);
+  } else {
+    if (content !== undefined) {
+      // // TODO: define `errCode` and `errMsg`
+      data.isERR = true;
+      data.errEvent = 'ERR_BAD_CONTENT';
+    };
+  };
+  return data;
 };
-
-/***
- * (* class definitions *)
- */
-
-// === module exports block ===
-
-module.exports.loadAliasFromFileSync = loadAliasFromFileSync;
 module.exports.saveAliasToFileSync = saveAliasToFileSync;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ygracs/chn-alias-list",
-  "version": "0.0.7-b",
+  "version": "0.0.8",
   "description": "A small library which provides some helper classes for EPG-tools",
   "author": "ygracs <cs70th-om@rambler.ru>",
   "license": "MIT",
@@ -11,7 +11,7 @@
   "main": "./index.js",
   "types": "./index.d.ts",
   "files": [
-    "doc/chn-alias-list.md",
+    "doc/*.md",
     "lib/chn-alias-list.js",
     "lib/file-helper-ext.js",
     "lib/*.d.ts",
@@ -31,10 +31,10 @@
   },
   "dependencies": {
     "@cntwg/file-helper": "^0.0.3",
-    "@ygracs/bsfoc-lib-js": "~0.3.3"
+    "@ygracs/bsfoc-lib-js": "~0.3.4"
   },
   "devDependencies": {
-    "@ygracs/test-helper": "~0.0.1-b",
+    "@ygracs/test-helper": "~0.0.2-b",
     "jest": "^30.2.0",
     "jsdoc-to-markdown": "^9.1.3",
     "minimist": "^1.2.8",