@ygracs/xepg-lib-js 0.0.22 → 0.0.23
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +15 -0
- package/doc/xepgdoc-lib.md +45 -6
- package/lib/xepgdoc-lib.js +270 -144
- package/package.json +8 -9
- package/lib/file-helper.js +0 -278
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,18 @@
|
|
|
1
|
+
#### *v0.0.23*
|
|
2
|
+
|
|
3
|
+
Pre-release version.
|
|
4
|
+
|
|
5
|
+
> - update `xepgdoc-lib.md`;
|
|
6
|
+
> - update dependency on `@ygracs/bsfoc-lib-js` module to v0.2.3;
|
|
7
|
+
> - update dependency on `@ygracs/dtf-lib-js` module to v0.0.28;
|
|
8
|
+
> - update dependency on `@ygracs/xobj-lib-js` module to v0.2.2;
|
|
9
|
+
> - updated dependency on `@ygracs/bsfoc-lib-js` module to v0.0.5-b;
|
|
10
|
+
> - add dependency on `@cntwg/file-helper` module;
|
|
11
|
+
> - remove `$module/lib/file-helper.js`;
|
|
12
|
+
> - improve behavior for a getter of a `rating` property of a `TXEpgScheduleItem`-class;
|
|
13
|
+
> - add functions: readAsTagName, `readAsAttrName`, valueToElementID;
|
|
14
|
+
> - other fixes.
|
|
15
|
+
|
|
1
16
|
#### *v0.0.22*
|
|
2
17
|
|
|
3
18
|
Pre-release version.
|
package/doc/xepgdoc-lib.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
|
-
|***rev.*:**|0.1.
|
|
1
|
+
|***rev.*:**|0.1.28|
|
|
2
2
|
|:---|---:|
|
|
3
|
-
|***date***:|2025-
|
|
3
|
+
|***date***:|2025-04-24|
|
|
4
4
|
|
|
5
5
|
## Introduction
|
|
6
6
|
|
|
7
7
|
This paper describes a constants and an object classes provided by `xepgdoc-lib.js` module.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
## Base type definitions
|
|
10
10
|
|
|
11
11
|
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.
|
|
12
12
|
|
|
@@ -63,6 +63,45 @@ This descriptor is an `object` that describes a content provider.
|
|
|
63
63
|
|
|
64
64
|
## Module constants
|
|
65
65
|
|
|
66
|
+
## Module functions
|
|
67
|
+
|
|
68
|
+
### Experimental functions
|
|
69
|
+
|
|
70
|
+
> Note: Purpose of those functions will be discussed and some may be deprecate and make obsolete or functionality may be altered. So use it with cautions in mind.
|
|
71
|
+
|
|
72
|
+
<a name="readAsTagName"></a>
|
|
73
|
+
#### **readAsTagName(value)** => `string`
|
|
74
|
+
|
|
75
|
+
> since: \[`v0.0.23`]
|
|
76
|
+
|
|
77
|
+
This function tries to convert a given `value` to the value of type which is suitable for an XML-element's tag name. If failed an empty string is returned.
|
|
78
|
+
|
|
79
|
+
| parameter name | value type | default value | description |
|
|
80
|
+
|:---|---|---:|:---|
|
|
81
|
+
| `value` | `any` | --- | some value to read |
|
|
82
|
+
|
|
83
|
+
<a name="readAsAttrName"></a>
|
|
84
|
+
#### **readAsAttrName(value)** => `string`
|
|
85
|
+
|
|
86
|
+
> since: \[`v0.0.23`]
|
|
87
|
+
|
|
88
|
+
This function tries to convert a given `value` to the value of type which is suitable for an XML-element's attribute name. If failed an empty string is returned.
|
|
89
|
+
|
|
90
|
+
| parameter name | value type | default value | description |
|
|
91
|
+
|:---|---|---:|:---|
|
|
92
|
+
| `value` | `any` | --- | some value to read |
|
|
93
|
+
|
|
94
|
+
<a name="valueToElementID"></a>
|
|
95
|
+
#### **valueToElementID(value)**
|
|
96
|
+
|
|
97
|
+
> since: \[`v0.0.23`]
|
|
98
|
+
|
|
99
|
+
This function tries to convert a given `value` to the value of a valid identifier which is suitable for an XML-element's ID-attribute. If failed an empty string is returned.
|
|
100
|
+
|
|
101
|
+
| parameter name | value type | default value | description |
|
|
102
|
+
|:---|---|---:|:---|
|
|
103
|
+
| `value` | `any` | --- | some value to read |
|
|
104
|
+
|
|
66
105
|
## Module classes
|
|
67
106
|
|
|
68
107
|
<a name="TXEpgScheduleItem"></a>
|
|
@@ -565,7 +604,7 @@ The `options` structure is listed below:
|
|
|
565
604
|
<a name="TXEpgHeaderContainer+Provider"></a>
|
|
566
605
|
##### **Provider**
|
|
567
606
|
|
|
568
|
-
> \[!] NOTE: `[since v0.0.22]` deprecated. Use
|
|
607
|
+
> \[!] NOTE: `[since v0.0.22]` deprecated. Use [`provider` property](#TXEpgHeaderContainer+provider) instead.
|
|
569
608
|
|
|
570
609
|
<a name="TXEpgHeaderContainer+provider"></a>
|
|
571
610
|
##### **provider**
|
|
@@ -696,7 +735,7 @@ The `options` structure is listed below:
|
|
|
696
735
|
<a name="TXEpgContentProvider+Header"></a>
|
|
697
736
|
##### **Header**
|
|
698
737
|
|
|
699
|
-
> \[!] NOTE: `[since v0.0.22]` deprecated. Use
|
|
738
|
+
> \[!] NOTE: `[since v0.0.22]` deprecated. Use [`header` property](#TXEpgContentProvider+header) instead.
|
|
700
739
|
|
|
701
740
|
<a name="TXEpgContentProvider+header"></a>
|
|
702
741
|
##### **header**
|
|
@@ -710,7 +749,7 @@ The `options` structure is listed below:
|
|
|
710
749
|
<a name="TXEpgContentProvider+Provider"></a>
|
|
711
750
|
##### **Provider**
|
|
712
751
|
|
|
713
|
-
> \[!] NOTE: `[since v0.0.22]` deprecated. Use
|
|
752
|
+
> \[!] NOTE: `[since v0.0.22]` deprecated. Use [`provider` property](#TXEpgContentProvider+provider) instead.
|
|
714
753
|
|
|
715
754
|
<a name="TXEpgContentProvider+provider"></a>
|
|
716
755
|
##### **provider**
|