@xaendar/common 0.6.14 → 0.6.16

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.
@@ -1,7 +1,8 @@
1
1
  /**
2
2
  * Indents each line of a code block by two spaces.
3
- * @param lines The lines of code to indent.
4
- * @return The indented line or an array of indented lines.
3
+ *
4
+ * @param lines - The line or lines of code to indent.
5
+ * @returns The indented line, or an array of indented lines.
5
6
  */
6
7
  export declare function indent(lines: string): string;
7
8
 
@@ -17,7 +18,8 @@ export declare function indent(lines: string[]): string[];
17
18
  * - not contain the following chars: '@', '#', '$', '%', '&', '*', '!', '?', '/', '\\', '|', "'", '"', '<', '>', '='
18
19
  * - not be a native HTML tag name.
19
20
  * - not be a reserved tag name.
20
- * @param tagName The tag name to validate.
21
+ *
22
+ * @param tagName - The tag name to validate.
21
23
  * @throws Will throw an error if the tag name is invalid.
22
24
  */
23
25
  export declare function isValidCustomElementName(tagName: string): boolean;
@@ -52,7 +52,10 @@ function indent(lines) {
52
52
  //#endregion
53
53
  //#region ../packages/common/src/costants/not-alllowed-tags.constants.ts
54
54
  /**
55
- * List of strings not allowed as names for CustomElements
55
+ * Tag names that are reserved by the HTML/SVG specifications and cannot be
56
+ * used as custom element names.
57
+ *
58
+ * @see https://html.spec.whatwg.org/multipage/custom-elements.html#valid-custom-element-name
56
59
  */
57
60
  var NOT_ALLOWED_TAGS = [
58
61
  "annotation-xml",
@@ -76,7 +79,8 @@ var NOT_ALLOWED_TAGS = [
76
79
  * - not contain the following chars: '@', '#', '$', '%', '&', '*', '!', '?', '/', '\\', '|', "'", '"', '<', '>', '='
77
80
  * - not be a native HTML tag name.
78
81
  * - not be a reserved tag name.
79
- * @param tagName The tag name to validate.
82
+ *
83
+ * @param tagName - The tag name to validate.
80
84
  * @throws Will throw an error if the tag name is invalid.
81
85
  */
82
86
  function isValidCustomElementName(tagName) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@xaendar/common",
3
- "version": "0.6.14",
3
+ "version": "0.6.16",
4
4
  "description": "A library containing common classes and utilities",
5
5
  "sideEffects": false,
6
6
  "type": "module",