npm - @qubit-ltd/common-decorator - Versions diffs - 3.8.9 - Mend

@qubit-ltd/common-decorator 3.8.9

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.

Files changed (55) hide show

package/LICENSE +201 -0
package/README.md +1156 -0
package/README.zh_CN.md +929 -0
package/dist/common-decorator.cjs +6818 -0
package/dist/common-decorator.cjs.map +1 -0
package/dist/common-decorator.min.cjs +1 -0
package/dist/common-decorator.min.cjs.map +1 -0
package/dist/common-decorator.min.mjs +1 -0
package/dist/common-decorator.min.mjs.map +1 -0
package/dist/common-decorator.mjs +6792 -0
package/dist/common-decorator.mjs.map +1 -0
package/doc/api/DefaultAssignmentOptions.html +678 -0
package/doc/api/DefaultOptions.html +954 -0
package/doc/api/DefaultToJsonOptions.html +633 -0
package/doc/api/Enum.html +1848 -0
package/doc/api/Model.html +3607 -0
package/doc/api/Page.html +1105 -0
package/doc/api/fonts/OpenSans-Bold-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Bold-webfont.svg +1838 -0
package/doc/api/fonts/OpenSans-Bold-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-BoldItalic-webfont.svg +1838 -0
package/doc/api/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-Italic-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Italic-webfont.svg +1838 -0
package/doc/api/fonts/OpenSans-Italic-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-Light-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Light-webfont.svg +1839 -0
package/doc/api/fonts/OpenSans-Light-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-LightItalic-webfont.svg +1843 -0
package/doc/api/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-Regular-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Regular-webfont.svg +1839 -0
package/doc/api/fonts/OpenSans-Regular-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-Semibold-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-Semibold-webfont.svg +1838 -0
package/doc/api/fonts/OpenSans-Semibold-webfont.ttf +0 -0
package/doc/api/fonts/OpenSans-Semibold-webfont.woff +0 -0
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.svg +1838 -0
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
package/doc/api/global.html +6049 -0
package/doc/api/index.html +1325 -0
package/doc/api/scripts/linenumber.js +34 -0
package/doc/api/scripts/prettify/Apache-License-2.0.txt +202 -0
package/doc/api/scripts/prettify/lang-css.js +2 -0
package/doc/api/scripts/prettify/prettify.js +28 -0
package/doc/api/styles/jsdoc-default.css +699 -0
package/doc/api/styles/prettify-jsdoc.css +120 -0
package/doc/api/styles/prettify-tomorrow.css +141 -0
package/doc/common-decorator.min.visualization.html +4949 -0
package/doc/common-decorator.visualization.html +4949 -0
package/package.json +107 -0

package/doc/api/Enum.html ADDED Viewed

@@ -0,0 +1,1848 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Enum - Documentation</title>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="https://cdn.bootcdn.net/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/ionicons/2.0.1/css/ionicons.min.css">
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+<label for="nav-trigger" class="overlay"></label>
+<nav>
+    <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="DefaultAssignmentOptions.html">DefaultAssignmentOptions</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="DefaultOptions.html">DefaultOptions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="DefaultOptions.html#.get">get</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="DefaultOptions.html#.merge">merge</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="DefaultOptions.html#.reset">reset</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="DefaultOptions.html#.set">set</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="DefaultToJsonOptions.html">DefaultToJsonOptions</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Page.html">Page</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Page.html#assign">assign</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Page.html#.getFrom">getFrom</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Page.html#.newEmpty">newEmpty</a></span></li><li class="nav-heading">Namespaces</li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="Enum.html">Enum</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.has">Class.has</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.hasCode">Class.hasCode</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.hasName">Class.hasName</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.hasValue">Class.hasValue</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.of">Class.of</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.ofCode">Class.ofCode</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.ofName">Class.ofName</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.ofValue">Class.ofValue</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.values">Class.values</a></span></li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="Model.html">Model</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#assign">assign</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#clear">clear</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#clone">clone</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#equals">equals</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#generateId">generateId</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#isEmpty">isEmpty</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#normalize">normalize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#normalizeField">normalizeField</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#toJSON">toJSON</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#toJsonString">toJsonString</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#validate">validate</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#validateField">validateField</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#.Class.create">Class.create</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#.Class.createArray">Class.createArray</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#.Class.createPage">Class.createPage</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#.Class.isNullishOrEmpty">Class.isNullishOrEmpty</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#.Class.parseJsonString">Class.parseJsonString</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#ElementType">ElementType</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Enumerable">Enumerable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Label">Label</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#NameField">NameField</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#NonEmpty">NonEmpty</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#NonEnumerable">NonEnumerable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Normalizable">Normalizable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Nullable">Nullable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Payload">Payload</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Readonly">Readonly</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Timeout">Timeout</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Type">Type</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Validatable">Validatable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#assign">assign</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#create">create</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#createArray">createArray</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#createPage">createPage</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#defaultNormalizer">defaultNormalizer</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#defaultValidator">defaultValidator</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#enumNormalizer">enumNormalizer</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isEnumClass">isEnumClass</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isEnumerator">isEnumerator</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isValidPageSource">isValidPageSource</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#normalize">normalize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#stringifyId">stringifyId</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#toJSON">toJSON</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#toJsonString">toJsonString</a></span></li>
+</nav>
+<div id="main">
+    <h1 class="page-title">Enum</h1>
+<section>
+<header>
+        <h2>
+        Enum
+        </h2>
+</header>
+<article>
+    <div class="container-overview">
+            <div class="description"><p>This decorator is used to decorate an enumeration class.</p>
+<p>It must decorate a class.</p>
+<p>An enumeration class is a class whose instances are enumerators. An enumerator
+is an object with the following properties:</p>
+<ul>
+<li><code>value</code>：the value of the enumerator, which is exactly the name of the
+static field of the enumeration class that corresponds to the enumerator.</li>
+<li><code>name</code>: the display name of the enumerator, which could be specified
+by the default string or object value of the static field of the
+enumeration class that corresponds to the enumerator. It the default value
+is not specified, the name of the enumerator is the same as its value.</li>
+<li><code>i18n</code>: the i18n key of the enumerator, which is an optional property. It
+could be specified by the default object value of the static field of the
+enumeration class that corresponds to the enumerator. If this property is
+specified, the <code>name</code> property will be transformed to a <code>getter</code>, which will
+get the i18n value of the enumerator from the i18n resource bundle.</li>
+<li><code>code</code>: the code of the enumerator, which is an optional property. It could
+be specified by the default object value of the static field of the
+enumeration class that corresponds to the enumerator.</li>
+<li>other properties: other properties of the enumerator could be specified
+by the default object value of the static field of the enumeration class
+that corresponds to the enumerator.</li>
+</ul>
+<p>An enumerator also has the following prototype method:</p>
+<ul>
+<li><code>toString()</code>: returns the value of the enumerator.</li>
+<li><code>toJSON()</code>: also returns the value of the enumerator.</li>
+</ul>
+<p>The enumeration class will have the following static methods:</p>
+<ul>
+<li><code>values()</code>: returns the array of all enumerators of this enumeration class.</li>
+<li><code>ofValue(value): returns the enumerator whose value is </code>value<code>, or </code>undefined` if no such enumerator exists.</li>
+<li><code>hasValue(value): returns </code>true<code>if there is an enumerator whose value is</code>value<code>, or </code>false` otherwise.</li>
+<li><code>ofName(name): returns the enumerator whose name is </code>name<code>, or </code>undefined`
+if no such enumerator exists.</li>
+<li><code>hasName(name): returns </code>true<code>if there is an enumerator whose name is</code>name<code>, or </code>false` otherwise.</li>
+<li><code>ofCode(code): returns the enumerator whose code is </code>code<code>, or </code>undefined`
+if no such enumerator exists.</li>
+<li><code>hasCode(code): returns </code>true<code>if there is an enumerator whose code is</code>code<code>, or </code>false` otherwise.</li>
+<li>`of(expr): returns the enumerator corresponding to the specified expression.
+The expression could be one of the following:
+<ul>
+<li>an enumerator of this enumeration class;</li>
+<li>or the value of an enumerator of this enumeration class;</li>
+<li>or the name of an enumerator of this enumeration class;</li>
+<li>or the code of an enumerator of this enumeration class.</li>
+</ul>
+</li>
+<li><code>has(value): returns </code>true<code>if there is an enumerator corresponding to the specified expression; or</code>false` otherwise. The expression could be one of
+the following:
+<ul>
+<li>an enumerator of this enumeration class;</li>
+<li>or the value of an enumerator of this enumeration class;</li>
+<li>or the name of an enumerator of this enumeration class;</li>
+<li>or the code of an enumerator of this enumeration class.</li>
+</ul>
+</li>
+</ul>
+<h5>Usage example:</h5>
+<pre class="prettyprint source lang-js"><code>&#064;Enum
+class Gender {
+  static MALE = 'Male';
+  static FEMALE = 'Female';
+}
+</code></pre>
+<p>The above code is equivalent to the following code:</p>
+<pre class="prettyprint source lang-js"><code>class Gender {
+  static MALE = Object.freeze(new Gender('MALE', 'Male'));
+  static FEMALE = Object.freeze(new Gender('FEMALE', 'Female'));
+  static values() {
+    return [ Gender.MALE, Gender.FEMALE ];
+  }
+  static ofValue(value) {
+    switch (value) {
+    case 'MALE':
+      return Gender.MALE;
+    case 'FEMALE':
+      return Gender.FEMALE;
+    default:
+      return undefined;
+    }
+  }
+  static hasValue(value) {
+    return Gender.ofValue(value) !== undefined;
+  }
+  static ofName(name) {
+    return Gender.values().find((e) => e.name === name);
+  }
+  static hasName(name) {
+    return Gender.ofName(name) !== undefined;
+  }
+  static ofCode(code) {
+    return Gender.values().find((e) => e.code === code);
+  }
+  static hasCode(code) {
+    return Gender.ofCode(code) !== undefined;
+  }
+  static of(expr) {
+    if (expr instanceof Gender) {
+      return expr;
+    } else {
+      return Gender.ofValue(expr) ?? Gender.ofName(expr) ?? Gender.ofCode(expr);
+    }
+  }
+  static has(expr) {
+    return Gender.of(expr) !== undefined;
+  }
+  constructor(value, name) {
+    this.value = value;
+    this.name = name;
+  }
+  toString() {
+    return this.value;
+  }
+  toJSON() {
+    return this.value;
+  }
+}
+</code></pre>
+<p>The static fields of the enumeration class could also be specified as objects,
+which will be used to initialize the enumerators. For example:</p>
+<pre class="prettyprint source lang-js"><code>&#064;Enum
+class Gender {
+  static MALE = { name: 'Male', i18n: 'i18n.gender.male', code: '001', data: { value: 0 } };
+  static FEMALE = { name: 'Female', i18n: 'i18n.gender.female', code: '002', data: { value: 1 } };
+}
+</code></pre>
+<p>The above code is equivalent to the following code:</p>
+<pre class="prettyprint source lang-js"><code>class Gender {
+  static MALE = Object.freeze(new Gender('MALE', 'Male',
+     { i18n: 'i18n.gender.male', code: '001', data: {value: 0 } }));
+  static FEMALE = Object.freeze(new Gender('FEMALE', 'Female',
+     { i18n: 'i18n.gender.female', code: '002', data: {value: 1 } }));
+  ...
+  constructor(value, name, payload) {
+    this.value = value;
+    this.name = name;
+    Object.assign(this, payload);
+  }
+  ...
+}
+</code></pre>
+<p>Note that the enumerator in the above <code>Gender</code> class has a <code>code</code>, <code>i18n</code>
+and <code>data</code> properties. Since it has <code>i18n</code> property which specifies the i18n
+key of the enumerator in the resource bundle, the <code>name</code> property of the
+enumerator will be transformed to a <code>getter</code> which will get the i18n value
+corresponding to the i18n key from the i18n resource bundle.</p>
+<p>The enumerators can also be defined without default values, for example:</p>
+<pre class="prettyprint source lang-js"><code>&#064;Enum
+class Gender {
+  static MALE;
+  static FEMALE;
+}
+</code></pre>
+<p>The above code is equivalent to the following code:</p>
+<pre class="prettyprint source lang-js"><code>class Gender {
+  static MALE = Object.freeze(new Gender('MALE'));
+  static FEMALE = Object.freeze(new Gender('FEMALE'));
+  ...
+  constructor(value) {
+    this.value = value;
+    this.name = value;
+  }
+  ...
+}
+</code></pre>
+<p>That is, the name of the enumerator is exactly its value.</p></div>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li>Haixing Hu</li>
+        </ul>
+    </dd>
+</dl>
+    </div>
+        <h3 class="subsection-title">Methods</h3>
+<div class="section-method">
+    <h4 class="name" id=".Class.has"><span class="type-signature">(static) </span>Class.has<span class="signature">(expr)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
+<div class="description">
+    <p>Tests whether there is an enumerator of this enumeration class corresponding
+to the specified expression.</p>
+<p>The expression could be one of the following:</p>
+<ul>
+<li>an enumerator of this enumeration class;</li>
+<li>or the value of an enumerator of this enumeration class;</li>
+<li>or the name of an enumerator of this enumeration class;</li>
+<li>or the code of an enumerator of this enumeration class.</li>
+</ul>
+</div>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li>Haixing Hu</li>
+        </ul>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>expr</code></td>
+            <td class="type">
+<span class="param-type"><code>object</code></span>
+|
+<span class="param-type"><code>string</code></span>
+            </td>
+            <td class="description last">
+                <p>The specified expression, which could be an enumerator object, the value
+of an enumerator, the name of an enumerator, or the code of an enumerator.</p>
+            </td>
+        </tr>
+    </tbody>
+</table>
+<div class="section-returns">
+<h5>Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type:
+    </dt>
+    <dd>
+<span class="param-type"><code>boolean</code></span>
+    </dd>
+</dl>
+<div class="param-desc">
+    <p><code>true</code> if there is an enumerator corresponding to the specified
+enumerator, value, name or code; <code>false</code> otherwise.</p>
+</div>
+</div>
+</div>
+<div class="section-method">
+    <h4 class="name" id=".Class.hasCode"><span class="type-signature">(static) </span>Class.hasCode<span class="signature">(code)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
+<div class="description">
+    <p>Tests whether there is an enumerator of this enumeration class which has
+the specified code.</p>
+</div>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li>Haixing Hu</li>
+        </ul>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>code</code></td>
+            <td class="type">
+<span class="param-type"><code>string</code></span>
+            </td>
+            <td class="description last">
+                <p>The specified code. If the code is a primitive string or a <code>String</code>
+object, it will be trimmed.</p>
+            </td>
+        </tr>
+    </tbody>
+</table>
+<div class="section-returns">
+<h5>Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type:
+    </dt>
+    <dd>
+<span class="param-type"><code>boolean</code></span>
+    </dd>
+</dl>
+<div class="param-desc">
+    <p><code>true</code> if there is an enumerator of this enumeration class which has
+the specified code; <code>false</code> otherwise.</p>
+</div>
+</div>
+</div>
+<div class="section-method">
+    <h4 class="name" id=".Class.hasName"><span class="type-signature">(static) </span>Class.hasName<span class="signature">(name)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
+<div class="description">
+    <p>Tests whether there is an enumerator of this enumeration class which has
+the specified name.</p>
+</div>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li>Haixing Hu</li>
+        </ul>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>name</code></td>
+            <td class="type">
+<span class="param-type"><code>string</code></span>
+            </td>
+            <td class="description last">
+                <p>The specified name. If the name is a primitive string or a <code>String</code>
+object, it will be trimmed.</p>
+            </td>
+        </tr>
+    </tbody>
+</table>
+<div class="section-returns">
+<h5>Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type:
+    </dt>
+    <dd>
+<span class="param-type"><code>boolean</code></span>
+    </dd>
+</dl>
+<div class="param-desc">
+    <p><code>true</code> if there is an enumerator of this enumeration class which has
+the specified name; <code>false</code> otherwise.</p>
+</div>
+</div>
+</div>
+<div class="section-method">
+    <h4 class="name" id=".Class.hasValue"><span class="type-signature">(static) </span>Class.hasValue<span class="signature">(value)</span><span class="type-signature"> &rarr; {boolean}</span></h4>
+<div class="description">
+    <p>Tests whether there is an enumerator of this enumeration class which has
+the specified value.</p>
+</div>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li>Haixing Hu</li>
+        </ul>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>value</code></td>
+            <td class="type">
+<span class="param-type"><code>string</code></span>
+            </td>
+            <td class="description last">
+                <p>The value of the enumerator to be tested. If the value is a primitive
+string or a <code>String</code> object, it will be trimmed and converted to an
+uppercase string.</p>
+            </td>
+        </tr>
+    </tbody>
+</table>
+<div class="section-returns">
+<h5>Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type:
+    </dt>
+    <dd>
+<span class="param-type"><code>boolean</code></span>
+    </dd>
+</dl>
+<div class="param-desc">
+    <p><code>true</code> if there is an enumerator of this enumeration class which has
+the specified value; <code>false</code> otherwise.</p>
+</div>
+</div>
+</div>
+<div class="section-method">
+    <h4 class="name" id=".Class.of"><span class="type-signature">(static) </span>Class.of<span class="signature">(expr)</span><span class="type-signature"> &rarr; {undefined|object}</span></h4>
+<div class="description">
+    <p>Returns the enumerator of this enumeration class corresponding to the
+specified expression.</p>
+<p>The expression could be one of the following:</p>
+<ul>
+<li>an enumerator of this enumeration class;</li>
+<li>or the value of an enumerator of this enumeration class;</li>
+<li>or the name of an enumerator of this enumeration class;</li>
+<li>or the code of an enumerator of this enumeration class.</li>
+</ul>
+</div>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li>Haixing Hu</li>
+        </ul>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>expr</code></td>
+            <td class="type">
+<span class="param-type"><code>object</code></span>
+|
+<span class="param-type"><code>string</code></span>
+            </td>
+            <td class="description last">
+                <p>The specified value, which could be an enumerator object, the value of
+an enumerator, the name of an enumerator, or the code of an enumerator.</p>
+            </td>
+        </tr>
+    </tbody>
+</table>
+<div class="section-returns">
+<h5>Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type:
+    </dt>
+    <dd>
+<span class="param-type"><code>undefined</code></span>
+|
+<span class="param-type"><code>object</code></span>
+    </dd>
+</dl>
+<div class="param-desc">
+    <p>The enumerator corresponding to the specified enumerator, value, name
+or code; or <code>undefined</code> if there is no such enumerator.</p>
+</div>
+</div>
+</div>
+<div class="section-method">
+    <h4 class="name" id=".Class.ofCode"><span class="type-signature">(static) </span>Class.ofCode<span class="signature">(code)</span><span class="type-signature"> &rarr; {undefined|Class}</span></h4>
+<div class="description">
+    <p>Returns the enumerator of this enumeration class which has the specified
+code.</p>
+</div>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li>Haixing Hu</li>
+        </ul>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>code</code></td>
+            <td class="type">
+<span class="param-type"><code>string</code></span>
+            </td>
+            <td class="description last">
+                <p>The code of the enumerator to be returned. If the code is a primitive
+string or a <code>String</code> object, it will be trimmed.</p>
+            </td>
+        </tr>
+    </tbody>
+</table>
+<div class="section-returns">
+<h5>Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type:
+    </dt>
+    <dd>
+<span class="param-type"><code>undefined</code></span>
+|
+<span class="param-type"><code>Class</code></span>
+    </dd>
+</dl>
+<div class="param-desc">
+    <p>The enumerator of this enumeration class which has the specified code;
+or <code>undefined</code> if there is no such enumerator.</p>
+</div>
+</div>
+</div>
+<div class="section-method">
+    <h4 class="name" id=".Class.ofName"><span class="type-signature">(static) </span>Class.ofName<span class="signature">(name)</span><span class="type-signature"> &rarr; {undefined|Class}</span></h4>
+<div class="description">
+    <p>Returns the enumerator of this enumeration class which has the specified
+name.</p>
+</div>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li>Haixing Hu</li>
+        </ul>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>name</code></td>
+            <td class="type">
+<span class="param-type"><code>string</code></span>
+            </td>
+            <td class="description last">
+                <p>The name of the enumerator to be returned.  If the name is a primitive
+string or a <code>String</code> object, it will be trimmed.</p>
+            </td>
+        </tr>
+    </tbody>
+</table>
+<div class="section-returns">
+<h5>Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type:
+    </dt>
+    <dd>
+<span class="param-type"><code>undefined</code></span>
+|
+<span class="param-type"><code>Class</code></span>
+    </dd>
+</dl>
+<div class="param-desc">
+    <p>The enumerator of this enumeration class which has the specified name;
+or <code>undefined</code> if there is no such enumerator.</p>
+</div>
+</div>
+</div>
+<div class="section-method">
+    <h4 class="name" id=".Class.ofValue"><span class="type-signature">(static) </span>Class.ofValue<span class="signature">(value)</span><span class="type-signature"> &rarr; {undefined|Class}</span></h4>
+<div class="description">
+    <p>Returns the enumerator of this enumeration class which has the specified
+value.</p>
+</div>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li>Haixing Hu</li>
+        </ul>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>value</code></td>
+            <td class="type">
+<span class="param-type"><code>string</code></span>
+            </td>
+            <td class="description last">
+                <p>The value of the enumerator to be returned. If the value is a primitive
+string or a <code>String</code> object, it will be trimmed and converted to an
+uppercase string.</p>
+            </td>
+        </tr>
+    </tbody>
+</table>
+<div class="section-returns">
+<h5>Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type:
+    </dt>
+    <dd>
+<span class="param-type"><code>undefined</code></span>
+|
+<span class="param-type"><code>Class</code></span>
+    </dd>
+</dl>
+<div class="param-desc">
+    <p>The enumerator of this enumeration class which has the specified value;
+or <code>undefined</code> if there is no such enumerator.</p>
+</div>
+</div>
+</div>
+<div class="section-method">
+    <h4 class="name" id=".Class.values"><span class="type-signature">(static) </span>Class.values<span class="signature">()</span><span class="type-signature"> &rarr; {Array.&lt;object>}</span></h4>
+<div class="description">
+    <p>Returns the array of all enumerators of this enumeration class.</p>
+</div>
+<dl class="details">
+</dl>
+<div class="section-returns">
+<h5>Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type:
+    </dt>
+    <dd>
+<span class="param-type"><code>Array.&lt;object></code></span>
+    </dd>
+</dl>
+<div class="param-desc">
+    <p>The array of all enumerators of this enumeration class.</p>
+</div>
+</div>
+</div>
+</article>
+</section>
+</div>
+<br class="clear">
+<footer>
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
+     on Mon Jan 06 2025 12:25:48 GMT+0800 (China Standard Time)
+    using the <a href="https://github.com/Haixing-Hu/jsdoc-minami">customized Minami theme</a>.
+</footer>
+<script>prettyPrint();</script>
+<script src="scripts/linenumber.js"></script>
+</body>
+</html>