@ygracs/xepg-lib-js 0.0.20 → 0.0.22

package/doc/xepgdoc-lib.md

@@ -1,15 +1,199 @@
-|***rev.*:**|0.0.15|
+|***rev.*:**|0.1.26|
 |:---|---:|
-|***date***:|2024-10-28|
+|***date***:|2025-03-06|
 
 ## Introduction
 
 This paper describes a constants and an object classes provided by `xepgdoc-lib.js` module.
 
+### 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+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` | no | an error message |
+| `source` | `string` | no | path to a file |
+| `content` | `any` | no | content |
+
+<a name="typedef+xepgProvInfoDesc"></a>
+#### `xepgProvInfoDesc` - descriptor
+
+This descriptor is an `object` that describes a content provider.
+
+| property name | value type | optional | description |
+|:---|---|---:|:---|
+| `name` | `string` | yes | a provider name |
+| `version` | `string` | yes | a provider version |
+| `schema` | `string` | no | a document schema version |
+| `doctype` | `string` | no | a document type |
+
+<a name="typedef+xepgChnInfoDesc"></a>
+#### `xepgChnInfoDesc` - descriptor
+
+This descriptor is an `object` that describes a channel info.
+
+| property name | value type | optional | description |
+|:---|---|---:|:---|
+| `chnid` | `srting` | no | a channel ID |
+| `chname` | `string` | no | a name of the channel |
+| `chngid` | `string` | yes | a channel 'Group ID' |
+| `srcurl` | `string` | yes | a link to source |
+
+<a name="typedef+xepgShedInfoDesc"></a>
+#### `xepgShedInfoDesc` - descriptor
+
+This descriptor is an `object` that describes a content provider.
+
+| property name | value type | optional | description |
+|:---|---|---:|:---|
+| `time` | `number` | no | a schedule start time |
+| `title` | `string` | no | a schedule title |
+| `cat` | `string` | yes | a schedule category |
+| `pcmark` | `number` | yes | a schedule rating |
+| `descr` | `string` | yes | a schedule description |
+
 ## Module constants
 
 ## Module classes
 
+<a name="TXEpgScheduleItem"></a>
+### **TXEpgScheduleItem**
+
+> since: `v0.0.22`
+
+This class provides a functionality for handle an EPG-schedule element.
+
+#### class constructor
+
+The class constructor creates a new instance of the class.
+
+##### constructor parameters
+
+The class constructor receives arguments listed below:
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+|`object`|`object`|---|a host object|
+|`options`|`object`|---|an options settings|
+
+#### class properties
+
+<a name="TXEpgScheduleItem+time"></a>
+##### **time**
+
+| property type | read only | description |
+|---|---|:---|
+| `number` | yes | contains a schedule start time value as a timestamp |
+
+<a name="TXEpgScheduleItem+title"></a>
+##### **title**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | yes | contains a schedule title |
+
+<a name="TXEpgScheduleItem+category"></a>
+##### **category**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | yes | contains a schedule category |
+
+<a name="TXEpgScheduleItem+rating"></a>
+##### **rating**
+
+| property type | read only | description |
+|---|---|:---|
+| `number` | yes | contains a schedule rating value (*aka pcmark*) |
+
+<a name="TXEpgScheduleItem+descr"></a>
+##### **descr**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | yes | contains a schedule description |
+
+<a name="TXEpgScheduleItem+dtstype"></a>
+##### **dtstype**
+
+| property type | read only | description |
+|---|---|:---|
+| `number` | yes | contains a "dtstype"-value |
+
+<a name="TXEpgScheduleItem+curDocTZ"></a>
+##### **curDocTZ**
+
+| property type | read only | description |
+|---|---|:---|
+| `number` | yes | contains a current TimeZone |
+
+#### class methods
+
+<a name="TXEpgScheduleItem+getInfo"></a>
+##### **getInfo()** => `xepgShedInfoDesc`
+
+This method returns an object that contains a schedule information.
+
+<a name="TXEpgScheduleItem+setTime"></a>
+##### **setTime(value)** => `boolean`
+
+This method tries to set a schedule start time. If succeed `true` returned.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `number`, `string`, `Date` | --- | some value |
+
+<a name="TXEpgScheduleItem+setTitle"></a>
+##### **setTitle(value)** => `boolean`
+
+This method tries to set a schedule title. If succeed `true` returned.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `string` | --- | some value |
+
+<a name="TXEpgScheduleItem+setCategory"></a>
+##### **setCategory(value)** => `boolean`
+
+This method tries to set a schedule category. If succeed `true` returned.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `string` | --- | some value |
+
+<a name="TXEpgScheduleItem+setRating"></a>
+##### **setRating(value)** => `boolean`
+
+This method tries to set a schedule rating. If succeed `true` returned.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `number`, `string` | --- | some rating value |
+
+<a name="TXEpgScheduleItem+setDescr"></a>
+##### **setDescr(value)** => `boolean`
+
+This method tries to set a schedule description. If succeed `true` returned.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `string` | --- | some value |
+
+<a name="TXEpgScheduleItem+saveToXMLString"></a>
+##### **saveToXMLString()** => `string`
+
+This method saves an element content to a string in an XML-format.
+
+<a name="TXEpgSchedulesList"></a>
 ### **TXEpgSchedulesList**
 
 This class provides a functionality for handle an EPG-schedules list.
@@ -22,27 +206,42 @@ The class constructor creates a new instance of the class.
 
 The class constructor receives arguments listed below:
 
-|name|type|default value|description|
+| parameter name | value type | default value | description |
 |:---|---|---:|:---|
 |`object`|`array`|---|a host object|
 |`options`|`object`|---|an options settings|
 
 #### class properties
 
-The table below describes a properties of a `TXEpgSchedulesList` class:
+<a name="TXEpgSchedulesList+schedQty"></a>
+##### **schedQty**
+
+| property type | read only | description |
+|---|---|:---|
+| `number` | yes | contains a quantity of the elements the container holds |
+
+<a name="TXEpgSchedulesList+dtstype"></a>
+##### **dtstype**
 
-|property name|property type|read only|description|
-|:---|---|---|:---|
-|`schedQty`|`number`|yes|returns a quantity of the elements|
-|`dtstype`|`index`|yes|returns a "dtstype"-value|
-|`curDocTZ`|`number`|yes|returns a current TimeZone|
+| property type | read only | description |
+|---|---|:---|
+| `number` | yes | contains a "dtstype"-value |
+
+<a name="TXEpgSchedulesList+curDocTZ"></a>
+##### **curDocTZ**
+
+| property type | read only | description |
+|---|---|:---|
+| `number` | yes | contains a current TimeZone |
 
 #### class methods
 
+<a name="TXEpgSchedulesList+hasNoSchedules"></a>
 ##### **hasNoSchedules()** => `boolean`
 
 This method returns `true` if a document contains no schedules.
 
+<a name="TXEpgSchedulesList+hasSchedules"></a>
 ##### **hasSchedules()** => `boolean`
 
 This method returns `true` if a document contains at least one schedule.
@@ -51,17 +250,39 @@ This method returns `true` if a document contains at least one schedule.
 
 > WARNING: This method deprecated (*since `v0.0.20`*). Use `chkIndex` instead.
 
+<a name="TXEpgSchedulesList+chkIndex"></a>
 ##### **chkIndex(value)** => `boolean`
 
 > since: `v0.0.20`
 
 This method checks if a given `value` represents a valid schedule index and if so returns `true`.
 
-##### **getScheduleInfo(index)** => `object`
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `number`, `string` | --- | a value to be verified |
+
+<a name="TXEpgSchedulesList+schedule"></a>
+##### **schedule(index)** => `TXEpgScheduleItem`
+
+> since: `v0.0.22`
+
+This method returns an object that contains a schedule element.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `index` | `number`, `string` | --- | an element index |
+
+<a name="TXEpgSchedulesList+getScheduleInfo"></a>
+##### **getScheduleInfo(index)** => `xepgShedInfoDesc`
 
 This method returns an object that contains a schedule information.
 
-##### **getAllSchedulesInfo()** => `object[]`
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `index` | `number`, `string` | --- | an element index |
+
+<a name="TXEpgSchedulesList+getAllSchedulesInfo"></a>
+##### **getAllSchedulesInfo()** => `xepgShedInfoDesc[]`
 
 This method returns an array that contains an information for all available schedules.
 
@@ -69,6 +290,7 @@ This method returns an array that contains an information for all available sche
 
 ##### **asJSON()**
 
+<a name="TXEpgProviderContainer"></a>
 ### **TXEpgProviderContainer**
 
 This class implements a structure that holds an information about a program provider within which the content of the document was written.
@@ -94,22 +316,47 @@ The `options` structure is listed below:
 
 #### class properties
 
-The table below describes a properties of a `TXEpgProviderContainer` class:
+<a name="TXEpgProviderContainer+name"></a>
+##### **name**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | no | contains a provider name |
 
-|property name|property type|read only|description|
-|:---|---|---|:---|
-|`name`|`string`|no|defines a provider name|
-|`version`|`string`|no|defines a provider version string|
-|`schema`|`string`|no|defines a document schema version|
-|`doctype`|`string`|no|defines a document type|
+<a name="TXEpgProviderContainer+version"></a>
+##### **version**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | no | contains a provider version string |
+
+<a name="TXEpgProviderContainer+schema"></a>
+##### **schema**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | no | contains a document schema version |
+
+<a name="TXEpgProviderContainer+doctype"></a>
+##### **doctype**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | no | contains a document type |
 
 #### class methods
 
+<a name="TXEpgProviderContainer+setName"></a>
 ##### **setName(value)** => `boolean`
 
 This method sets a name of a provider to a given `value`.
 
-##### **getInfo()** => `object`
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `string` | --- | provider name |
+
+<a name="TXEpgProviderContainer+getInfo"></a>
+##### **getInfo()** => `xepgProvInfoDesc`
 
 This method returns an `object` that contains information about content provider. An object contains a field listed in the table below:
 
@@ -120,11 +367,16 @@ This method returns an `object` that contains information about content provider
 |`schema`|`string`|a document schema version|
 |`doctype`|`string`|a document type|
 
-
+<a name="TXEpgProviderContainer+setInfo"></a>
 ##### **setInfo(obj)** => `void`
 
 This method loads information about content provider.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `obj` | `xepgProvInfoDesc` | --- | provider info descriptor |
+
+<a name="TXEpgProviderContainer+saveToXMLString"></a>
 ##### **saveToXMLString()** => `string`
 
 > since: `v0.0.20`
@@ -135,8 +387,86 @@ This method saves an element content to a string.
 
 ##### **init()**
 
+<a name="TXEpgChannelContainer"></a>
+### **TXEpgChannelContainer**
+
+> since: `v0.0.22`
+
+This class provides a functionality for handle an EPG-channel element.
+
+#### class constructor
+
+The class constructor creates a new instance of the class.
+
+##### constructor parameters
+
+The class constructor receives arguments listed below:
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+|`object`|`object`|---|a host object|
+|`options`|`object`|---|an options settings|
+
+#### class properties
+
+<a name="TXEpgChannelContainer+id"></a>
+##### **id**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | yes | contains a channel ID |
+
+<a name="TXEpgChannelContainer+name"></a>
+##### **name**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | no | contains a channel name |
+
+<a name="TXEpgChannelContainer+gid"></a>
+##### **gid**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | no | contains a channel group ID |
+
+<a name="TXEpgChannelContainer+url"></a>
+##### **url**
+
+| property type | read only | description |
+|---|---|:---|
+| `string` | no | contains a channel URL |
+
+#### class methods
+
+<a name="TXEpgChannelContainer+setID"></a>
+##### **setID(value)** => `boolean`
+
+This method tries to set a channel ID. If succeed `true` returned.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `string` | --- | some value |
+
+<a name="TXEpgChannelContainer+getInfo"></a>
+##### **getInfo()** => `xepgChnInfoDesc`
+
+This method returns a channel info descriptor.
+
+<a name="TXEpgChannelContainer+setInfo"></a>
+##### **setInfo(value)** => `void`
+
+This method tries to load a channel info.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `string`, `xepgChnInfoDesc` | --- | some value |
+
+<a name="TXEpgDTSProvider"></a>
 ### **TXEpgDTSProvider**
 
+This class provides a functionality for handle a DTS-provider element.
+
 #### class constructor
 
 The class constructor creates a new instance of the class.
@@ -158,15 +488,38 @@ The `options` structure is listed below:
 
 #### class properties
 
-The table below describes a properties of a `TXEpgDTSProvider` class:
+<a name="TXEpgDTSProvider+dtstype"></a>
+##### **dtstype**
+
+| property type | read only | description |
+|---|---|:---|
+| `number` | no | defines a "dtstype"-value |
+
+<a name="TXEpgDTSProvider+curDocTZ"></a>
+##### **curDocTZ**
+
+| property type | read only | description |
+|---|---|:---|
+| `number` | no | defines a current TimeZone |
+
+#### class methods
+
+<a name="TXEpgDTSProvider+setType"></a>
+##### **setType(value)** => `boolean`
+
+> since: `v0.0.22`
 
-|property name|property type|read only|description|
-|:---|---|---|:---|
-|`dtstype`|`index`|no|defines a "dtstype"-value|
-|`curDocTZ`|`number`|no|defines a current TimeZone|
+This method tries to set a provider type.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `number`, `string` | --- | a "dtstype"-value |
+
+<a name="TXEpgHeaderContainer"></a>
 ### **TXEpgHeaderContainer**
 
+This class provides a functionality for handle a EPG-header element.
+
 #### class constructor
 
 The class constructor creates a new instance of the class.
@@ -188,36 +541,80 @@ The `options` structure is listed below:
 
 #### class properties
 
-The table below describes a properties of a `TXEpgHeaderContainer` class:
+<a name="TXEpgHeaderContainer+dts"></a>
+##### **dts**
 
-|property name|property type|read only|description|
-|:---|---|---:|:---|
-|`dtstype`|`index`|no|defines a "dtstype"-value|
-|`curDocTZ`|`number`|no|defines a current TimeZone|
-|`Provider`|`TXEpgProviderContainer`|yes|returns a `TXEpgProviderContainer`|
-|`dts`|`TXepgDTSProvider`|yes|returns a `TXEpgDTSProvider`|
+| property type | read only | description |
+|---|---|:---|
+| `TXEpgDTSProvider` | yes | returns a `TXEpgDTSProvider` |
+
+<a name="TXEpgHeaderContainer+dtstype"></a>
+##### **dtstype**
+
+| property type | read only | description |
+|---|---|:---|
+| `number` | no | defines a "dtstype"-value |
+
+<a name="TXEpgHeaderContainer+curDocTZ"></a>
+##### **curDocTZ**
+
+| property type | read only | description |
+|---|---|:---|
+| `number` | no | defines a current TimeZone |
+
+<a name="TXEpgHeaderContainer+Provider"></a>
+##### **Provider**
+
+> \[!] NOTE: `[since v0.0.22]` deprecated. Use (`provider` property)[#TXEpgHeaderContainer+provider] instead.
+
+<a name="TXEpgHeaderContainer+provider"></a>
+##### **provider**
+
+> since: `v0.0.22`
+
+| property type | read only | description |
+|---|---|:---|
+| `TXEpgProviderContainer` | yes | returns a `TXEpgProviderContainer` instance |
+
+<a name="TXEpgHeaderContainer+channel"></a>
+##### **channel**
+
+> since: `v0.0.22`
+
+| property type | read only | description |
+|---|---|:---|
+| `TXEpgChannelContainer` | yes | returns a `TXEpgChannelContainer` instance |
 
 #### class methods
 
+<a name="TXEpgHeaderContainer+getDocumentDT"></a>
 ##### **getDocumentDT()** => `number`
 
 This method returns a time value of a document creation as a timestamp.
 
+<a name="TXEpgHeaderContainer+setDocumentDT"></a>
 ##### **setDocumentDT()** => `void`
 
 This method sets a time value of a document creation.
 
+<a name="TXEpgHeaderContainer+getDocumentEDT"></a>
 ##### **getDocumentEDT()** => `number`
 
 This method returns a time value from which a document is expired as a timestamp.
 
+<a name="TXEpgHeaderContainer+setDocumentEDT"></a>
 ##### **setDocumentEDT(value)** => `void`
 
 This method sets a time value at which a document will be expired.
 
-##### **getChannelInfo()** => `object`
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `value` | `number`, `string`, `Date` | --- | document expire time |
+
+<a name="TXEpgHeaderContainer+getChannelInfo"></a>
+##### **getChannelInfo()** => `xepgChnInfoDesc`
 
-This method returns an object which contains a channel information.
+This method returns an `object` which contains a channel information.
 
 An object contains the following fields:
 
@@ -228,10 +625,19 @@ An object contains the following fields:
 |`chname`|`string`|a name of the channel|
 |`srcurl`|`string`|a link to source|
 
+<a name="TXEpgHeaderContainer+setChannelInfo"></a>
 ##### **setChannelInfo(obj)** => `void`
 
+> \[!] WARNING: `[since v0.0.22]` deprecated.
+
 This method fills a channel information with a given data.
 
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `obj` | `xepgChnInfoDesc` | --- | channel info descriptor |
+
+> \[!] NOTE: `[since v0.0.21]` a use of a `string` or `array` types a as values of an `obj` are deprecated and will be dropped soon.
+
 The `obj` parameter can be a string or an array or an object.
 
 If a string is given it mean to contains the `chnid` value.
@@ -249,18 +655,21 @@ If an object is given it contains the following fields:
 |`chngid`|`string`|a channel group|
 |`srcurl`|`string`|a link to source|
 
-##### **getProviderInfo()** => `object`
+<a name="TXEpgHeaderContainer+getProviderInfo"></a>
+##### **getProviderInfo()** => `xepgProvInfoDesc`
 
 This method returns an object which contains an information about document provider.
 
 ##### **setProviderInfo(obj)**
 
+<a name="TXEpgHeaderContainer+saveToXMLString"></a>
 ##### **saveToXMLString()** => `string`
 
 > since: `v0.0.20`
 
 This method saves an element content to a string.
 
+<a name="TXEpgContentProvider"></a>
 ### **TXEpgContentProvider**
 
 #### class constructor
@@ -284,50 +693,107 @@ The `options` structure is listed below:
 
 #### class properties
 
-The table below describes a properties of a `TXEpgContentProvider` class:
+<a name="TXEpgContentProvider+Header"></a>
+##### **Header**
+
+> \[!] NOTE: `[since v0.0.22]` deprecated. Use (`header` property)[#TXEpgContentProvider+header] instead.
+
+<a name="TXEpgContentProvider+header"></a>
+##### **header**
+
+> since: `v0.0.22`
 
-|property name|property type|read only|description|
-|:---|---|---|:---|
-|`Header`|`TXEpgHeaderContainer`|yes|returns a `TXEpgHeaderContainer`|
-|`Provider`|`TXEpgProviderContainer`|yes|returns a `TXEpgProviderContainer`|
-|`SchedulesList`|`TXEpgSchedulesList`|yes|returns a `TXEpgSchedulesList`|
-|`dts`|`TXEpgDTSProvider`|yes|returns a `TXEpgDTSProvider`|
+| property type | read only | description |
+|---|---|:---|
+| `TXEpgHeaderContainer` | yes | returns a `TXEpgHeaderContainer` instance |
+
+<a name="TXEpgContentProvider+Provider"></a>
+##### **Provider**
+
+> \[!] NOTE: `[since v0.0.22]` deprecated. Use (`provider` property)[#TXEpgContentProvider+provider] instead.
+
+<a name="TXEpgContentProvider+provider"></a>
+##### **provider**
+
+> since: `v0.0.22`
+
+| property type | read only | description |
+|---|---|:---|
+| `TXEpgProviderContainer` | yes | returns a `TXEpgProviderContainer` instance |
+
+<a name="TXEpgContentProvider+dts"></a>
+##### **dts**
+
+| property type | read only | description |
+|---|---|:---|
+| `TXEpgDTSProvider` | yes | returns a `TXEpgDTSProvider` instance |
+
+<a name="TXEpgContentProvider+SchedulesList"></a>
+##### **SchedulesList**
+
+| property type | read only | description |
+|---|---|:---|
+| `TXEpgSchedulesList` | yes | returns a `TXEpgSchedulesList` instance |
 
 #### class methods
 
+<a name="TXEpgContentProvider+saveToXMLString"></a>
+##### **saveToXMLString()** => `string`
+
+This method saves a document content to a string.
+
+<a name="TXEpgContentProvider+saveToFileSync"></a>
+##### **saveToFileSync(src)** => `fsoDescr`
+
+This method saves a document content into a file addressed by `src`.
+
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `src` | `string` | --- | path to a file |
+
 ##### **loadFromString(xmlString, options)** => `boolean`
 
 > WARNING: This method deprecated (*since `v0.0.18`*). Use `loadFromXMLString` instead.
 
-##### **loadFromXMLString(xmlString, options)** => `boolean`
+<a name="TXEpgContentProvider+loadFromXMLString"></a>
+##### **loadFromXMLString(str)** => `boolean`
 
 > since: `v0.0.18`
 
-This method loads a document content from string containing text in XML format.
-
-##### **loadFromFile(src)** => `object`
+This method loads a document content from a string given by `str`.
 
-This method loads a document content from a file. A `src` provided a string that is a path to the file.
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `str` | `string` | --- | some content |
 
-##### **loadFromFileSync(src)** => `object`
+<a name="TXEpgContentProvider+loadFromFileSync"></a>
+##### **loadFromFileSync(src)** => `fsoDescr`
 
-This method loads a document content from a file. A `src` provided a string that is a path to the file.
+This method loads a document content from a file addressed by `src`.
 
-##### **saveToXMLString()** => `string`
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `src` | `string` | --- | path to a file |
 
-This method saves a document content to a string.
+#### class methods (*async*)
 
-##### **saveToFile(src)** => `object`
+<a name="TXEpgContentProvider+saveToFile"></a>
+##### **saveToFile(src)** => `Promise<fsoDescr, Error>`
 
-This method saves a document content to a file. A `src` provided a string that is a path to the file.
+This method saves a document content into a file addressed by `src`.
 
-##### **saveToFileSync(src)** => `object`
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `src` | `string` | --- | path to a file |
 
-This method saves a document content to a file. A `src` provided a string that is a path to the file.
+<a name="TXEpgContentProvider+loadFromFile"></a>
+##### **loadFromFile(src)** => `Promise<fsoDescr, Error>`
 
-##### **asXML(options)**
+This method loads a document content from a file addressed by `src`.
 
-> WARNING: This method deprecated (*since `v0.0.18`*). Use `saveToXMLString` instead.
+| parameter name | value type | default value | description |
+|:---|---|---:|:---|
+| `src` | `string` | --- | path to a file |
 
 #### class methods (*special*)