@qubit-ltd/common-decorator 3.10.3 → 3.10.6
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/dist/common-decorator.cjs +230 -6292
- package/dist/common-decorator.cjs.map +1 -1
- package/dist/common-decorator.min.cjs +1 -1
- package/dist/common-decorator.min.cjs.map +1 -1
- package/dist/common-decorator.min.mjs +1 -1
- package/dist/common-decorator.min.mjs.map +1 -1
- package/dist/common-decorator.mjs +237 -6299
- package/dist/common-decorator.mjs.map +1 -1
- package/doc/api/DefaultAssignmentOptions.html +5 -5
- package/doc/api/DefaultOptions.html +6 -6
- package/doc/api/DefaultToJsonOptions.html +3 -3
- package/doc/api/Enum.html +4 -4
- package/doc/api/Model.html +4 -4
- package/doc/api/Page.html +3 -3
- package/doc/api/global.html +15 -15
- package/doc/api/index.html +4 -4
- package/doc/api/scripts/core.js +719 -726
- package/doc/api/scripts/core.min.js +23 -23
- package/doc/api/scripts/resize.js +90 -90
- package/doc/api/scripts/search.js +267 -265
- package/doc/api/scripts/search.min.js +5 -5
- package/doc/api/scripts/third-party/Apache-License-2.0.txt +202 -202
- package/doc/api/scripts/third-party/fuse.js +1749 -9
- package/doc/api/scripts/third-party/hljs-line-num-original.js +367 -369
- package/doc/api/scripts/third-party/hljs-line-num.js +1 -1
- package/doc/api/scripts/third-party/hljs-original.js +5260 -5171
- package/doc/api/scripts/third-party/hljs.js +1 -1
- package/doc/api/scripts/third-party/popper.js +1287 -5
- package/doc/api/scripts/third-party/tippy.js +1499 -1
- package/doc/api/scripts/third-party/tocbot.js +757 -672
- package/doc/api/scripts/third-party/tocbot.min.js +1 -1
- package/doc/api/styles/clean-jsdoc-theme-base.css +1257 -1159
- package/doc/api/styles/clean-jsdoc-theme-dark.css +412 -412
- package/doc/api/styles/clean-jsdoc-theme-light.css +482 -482
- package/doc/api/styles/clean-jsdoc-theme-scrollbar.css +29 -29
- package/doc/api/styles/clean-jsdoc-theme-without-scrollbar.min.css +1 -1
- package/doc/api/styles/clean-jsdoc-theme.min.css +1 -1
- package/doc/common-decorator.min.visualization.html +15 -15
- package/doc/common-decorator.visualization.html +15 -15
- package/package.json +44 -48
package/doc/api/Enum.html
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Namespace: Enum</title><!--[if lt IE 9]>
|
|
2
|
-
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
3
|
-
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="DefaultAssignmentOptions.html">DefaultAssignmentOptions</a></div><div class="sidebar-section-children"><a href="DefaultOptions.html">DefaultOptions</a></div><div class="sidebar-section-children"><a href="DefaultToJsonOptions.html">DefaultToJsonOptions</a></div><div class="sidebar-section-children"><a href="Page.html">Page</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-namespaces"><div>Namespaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Enum.html">Enum</a></div><div class="sidebar-section-children"><a href="Model.html">Model</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#ElementType">ElementType</a></div><div class="sidebar-section-children"><a href="global.html#Label">Label</a></div><div class="sidebar-section-children"><a href="global.html#NameField">NameField</a></div><div class="sidebar-section-children"><a href="global.html#NonEmpty">NonEmpty</a></div><div class="sidebar-section-children"><a href="global.html#Normalizable">Normalizable</a></div><div class="sidebar-section-children"><a href="global.html#Nullable">Nullable</a></div><div class="sidebar-section-children"><a href="global.html#Readonly">Readonly</a></div><div class="sidebar-section-children"><a href="global.html#Timeout">Timeout</a></div><div class="sidebar-section-children"><a href="global.html#Type">Type</a></div><div class="sidebar-section-children"><a href="global.html#Validatable">Validatable</a></div><div class="sidebar-section-children"><a href="global.html#assign">assign</a></div><div class="sidebar-section-children"><a href="global.html#create">create</a></div><div class="sidebar-section-children"><a href="global.html#createArray">createArray</a></div><div class="sidebar-section-children"><a href="global.html#createDeferredReadonlyInitializer">createDeferredReadonlyInitializer</a></div><div class="sidebar-section-children"><a href="global.html#createImmediateReadonlyInitializer">createImmediateReadonlyInitializer</a></div><div class="sidebar-section-children"><a href="global.html#createPage">createPage</a></div><div class="sidebar-section-children"><a href="global.html#defaultNormalizer">defaultNormalizer</a></div><div class="sidebar-section-children"><a href="global.html#defaultValidator">defaultValidator</a></div><div class="sidebar-section-children"><a href="global.html#enumNormalizer">enumNormalizer</a></div><div class="sidebar-section-children"><a href="global.html#getDefaultInstance">getDefaultInstance</a></div><div class="sidebar-section-children"><a href="global.html#getFieldElementType">getFieldElementType</a></div><div class="sidebar-section-children"><a href="global.html#getFieldType">getFieldType</a></div><div class="sidebar-section-children"><a href="global.html#getSourceField">getSourceField</a></div><div class="sidebar-section-children"><a href="global.html#hasOwnProperty">hasOwnProperty</a></div><div class="sidebar-section-children"><a href="global.html#hasProperty">hasProperty</a></div><div class="sidebar-section-children"><a href="global.html#hasPrototypeFunction">hasPrototypeFunction</a></div><div class="sidebar-section-children"><a href="global.html#isEnumClass">isEnumClass</a></div><div class="sidebar-section-children"><a href="global.html#isEnumerator">isEnumerator</a></div><div class="sidebar-section-children"><a href="global.html#isValidPageSource">isValidPageSource</a></div><div class="sidebar-section-children"><a href="global.html#normalize">normalize</a></div><div class="sidebar-section-children"><a href="global.html#stringifyId">stringifyId</a></div><div class="sidebar-section-children"><a href="global.html#toJSON">toJSON</a></div><div class="sidebar-section-children"><a href="global.html#toJsonString">toJsonString</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="Enum-title" class="has-anchor">Enum</h1></header><article><div class="container-overview"><h3 class="name has-anchor" id="Enum"><span class="type-signature"></span>Enum<span class="signature">(Class, context)</span></h3><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>@Enum
|
|
1
|
+
<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Namespace: Enum</title><!--[if lt IE 9]>
|
|
2
|
+
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
|
3
|
+
<![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="home-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M19 21H5a1 1 0 0 1-1-1v-9H1l10.327-9.388a1 1 0 0 1 1.346 0L23 11h-3v9a1 1 0 0 1-1 1zM6 19h12V9.157l-6-5.454-6 5.454V19z"/></symbol><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><div class="sidebar-items-container"><div class="sidebar-section-title"><a href="index.html" class="sidebar-home-anchor">首页</a></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-类"><div>类</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="DefaultAssignmentOptions.html">DefaultAssignmentOptions</a></div><div class="sidebar-section-children"><a href="DefaultOptions.html">DefaultOptions</a></div><div class="sidebar-section-children"><a href="DefaultToJsonOptions.html">DefaultToJsonOptions</a></div><div class="sidebar-section-children"><a href="Page.html">Page</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-命名空间"><div>命名空间</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Enum.html">Enum</a></div><div class="sidebar-section-children"><a href="Model.html">Model</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-全局"><div>全局</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#ElementType">ElementType</a></div><div class="sidebar-section-children"><a href="global.html#Label">Label</a></div><div class="sidebar-section-children"><a href="global.html#NameField">NameField</a></div><div class="sidebar-section-children"><a href="global.html#NonEmpty">NonEmpty</a></div><div class="sidebar-section-children"><a href="global.html#Normalizable">Normalizable</a></div><div class="sidebar-section-children"><a href="global.html#Nullable">Nullable</a></div><div class="sidebar-section-children"><a href="global.html#Readonly">Readonly</a></div><div class="sidebar-section-children"><a href="global.html#Timeout">Timeout</a></div><div class="sidebar-section-children"><a href="global.html#Type">Type</a></div><div class="sidebar-section-children"><a href="global.html#Validatable">Validatable</a></div><div class="sidebar-section-children"><a href="global.html#assign">assign</a></div><div class="sidebar-section-children"><a href="global.html#create">create</a></div><div class="sidebar-section-children"><a href="global.html#createArray">createArray</a></div><div class="sidebar-section-children"><a href="global.html#createDeferredReadonlyInitializer">createDeferredReadonlyInitializer</a></div><div class="sidebar-section-children"><a href="global.html#createImmediateReadonlyInitializer">createImmediateReadonlyInitializer</a></div><div class="sidebar-section-children"><a href="global.html#createPage">createPage</a></div><div class="sidebar-section-children"><a href="global.html#defaultNormalizer">defaultNormalizer</a></div><div class="sidebar-section-children"><a href="global.html#defaultValidator">defaultValidator</a></div><div class="sidebar-section-children"><a href="global.html#enumNormalizer">enumNormalizer</a></div><div class="sidebar-section-children"><a href="global.html#getDefaultInstance">getDefaultInstance</a></div><div class="sidebar-section-children"><a href="global.html#getFieldElementType">getFieldElementType</a></div><div class="sidebar-section-children"><a href="global.html#getFieldType">getFieldType</a></div><div class="sidebar-section-children"><a href="global.html#getSourceField">getSourceField</a></div><div class="sidebar-section-children"><a href="global.html#hasOwnProperty">hasOwnProperty</a></div><div class="sidebar-section-children"><a href="global.html#hasProperty">hasProperty</a></div><div class="sidebar-section-children"><a href="global.html#hasPrototypeFunction">hasPrototypeFunction</a></div><div class="sidebar-section-children"><a href="global.html#isEnumClass">isEnumClass</a></div><div class="sidebar-section-children"><a href="global.html#isEnumerator">isEnumerator</a></div><div class="sidebar-section-children"><a href="global.html#isValidPageSource">isValidPageSource</a></div><div class="sidebar-section-children"><a href="global.html#normalize">normalize</a></div><div class="sidebar-section-children"><a href="global.html#stringifyId">stringifyId</a></div><div class="sidebar-section-children"><a href="global.html#toJSON">toJSON</a></div><div class="sidebar-section-children"><a href="global.html#toJsonString">toJsonString</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button home-button" aria-label="go-to-homepage"><svg><use xlink:href="#home-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">本页内容</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="Enum-title" class="has-anchor">Enum</h1></header><article><div class="container-overview"><h3 class="name has-anchor" id="Enum"><span class="type-signature"></span>Enum<span class="signature">(Class, context)</span></h3><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>@Enum
|
|
4
4
|
class Gender {
|
|
5
5
|
static MALE = 'Male';
|
|
6
6
|
static FEMALE = 'Female';
|
|
@@ -112,4 +112,4 @@ class Gender {
|
|
|
112
112
|
|
|
113
113
|
...
|
|
114
114
|
}
|
|
115
|
-
</code></pre><p>That is, the name of the enumerator is exactly its value.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>Class</code></td><td class="type"><span class="param-type">function</span></td><td class="description last"><p>The constructor of the class being decorated.</p></td></tr><tr><td class="name"><code>context</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The context object containing information about the class being decorated.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-author bold">Author</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl></div><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id=".Class.has"><span class="type-signature">(static) </span>Class.has<span class="signature">(expr)</span><span class="type-signature"> → {boolean}</span></h3><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><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><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">object</span> |<wbr> <span class="param-type">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">Author</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><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><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id=".Class.hasCode"><span class="type-signature">(static) </span>Class.hasCode<span class="signature">(code)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Tests whether there is an enumerator of this enumeration class which has the specified code.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><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">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">Author</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><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><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id=".Class.hasName"><span class="type-signature">(static) </span>Class.hasName<span class="signature">(name)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Tests whether there is an enumerator of this enumeration class which has the specified name.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><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">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">Author</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><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><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id=".Class.hasValue"><span class="type-signature">(static) </span>Class.hasValue<span class="signature">(value)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Tests whether there is an enumerator of this enumeration class which has the specified value.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><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">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">Author</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><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><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id=".Class.of"><span class="type-signature">(static) </span>Class.of<span class="signature">(expr)</span><span class="type-signature"> → {undefined|object}</span></h3><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><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><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">object</span> |<wbr> <span class="param-type">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">Author</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><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><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">undefined</span> |<wbr> <span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id=".Class.ofCode"><span class="type-signature">(static) </span>Class.ofCode<span class="signature">(code)</span><span class="type-signature"> → {undefined|Class}</span></h3><div class="description"><p>Returns the enumerator of this enumeration class which has the specified code.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><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">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">Author</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><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><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">undefined</span> |<wbr> <span class="param-type">Class</span></dd></dl></div><h3 class="name has-anchor" id=".Class.ofName"><span class="type-signature">(static) </span>Class.ofName<span class="signature">(name)</span><span class="type-signature"> → {undefined|Class}</span></h3><div class="description"><p>Returns the enumerator of this enumeration class which has the specified name.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><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">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">Author</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><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><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">undefined</span> |<wbr> <span class="param-type">Class</span></dd></dl></div><h3 class="name has-anchor" id=".Class.ofValue"><span class="type-signature">(static) </span>Class.ofValue<span class="signature">(value)</span><span class="type-signature"> → {undefined|Class}</span></h3><div class="description"><p>Returns the enumerator of this enumeration class which has the specified value.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><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">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">Author</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><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><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">undefined</span> |<wbr> <span class="param-type">Class</span></dd></dl></div><h3 class="name has-anchor" id=".Class.values"><span class="type-signature">(static) </span>Class.values<span class="signature">()</span><span class="type-signature"> → {Array.<object>}</span></h3><div class="description"><p>Returns the array of all enumerators of this enumeration class.</p></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>The array of all enumerators of this enumeration class.</p></div><dl class="param-type"><dt>Type: </dt><dd><span class="param-type">Array.<object></span></dd></dl></div></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><div class="mobile-nav-links"></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="DefaultAssignmentOptions.html">DefaultAssignmentOptions</a></div><div class="sidebar-section-children"><a href="DefaultOptions.html">DefaultOptions</a></div><div class="sidebar-section-children"><a href="DefaultToJsonOptions.html">DefaultToJsonOptions</a></div><div class="sidebar-section-children"><a href="Page.html">Page</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-namespaces"><div>Namespaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Enum.html">Enum</a></div><div class="sidebar-section-children"><a href="Model.html">Model</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#ElementType">ElementType</a></div><div class="sidebar-section-children"><a href="global.html#Label">Label</a></div><div class="sidebar-section-children"><a href="global.html#NameField">NameField</a></div><div class="sidebar-section-children"><a href="global.html#NonEmpty">NonEmpty</a></div><div class="sidebar-section-children"><a href="global.html#Normalizable">Normalizable</a></div><div class="sidebar-section-children"><a href="global.html#Nullable">Nullable</a></div><div class="sidebar-section-children"><a href="global.html#Readonly">Readonly</a></div><div class="sidebar-section-children"><a href="global.html#Timeout">Timeout</a></div><div class="sidebar-section-children"><a href="global.html#Type">Type</a></div><div class="sidebar-section-children"><a href="global.html#Validatable">Validatable</a></div><div class="sidebar-section-children"><a href="global.html#assign">assign</a></div><div class="sidebar-section-children"><a href="global.html#create">create</a></div><div class="sidebar-section-children"><a href="global.html#createArray">createArray</a></div><div class="sidebar-section-children"><a href="global.html#createDeferredReadonlyInitializer">createDeferredReadonlyInitializer</a></div><div class="sidebar-section-children"><a href="global.html#createImmediateReadonlyInitializer">createImmediateReadonlyInitializer</a></div><div class="sidebar-section-children"><a href="global.html#createPage">createPage</a></div><div class="sidebar-section-children"><a href="global.html#defaultNormalizer">defaultNormalizer</a></div><div class="sidebar-section-children"><a href="global.html#defaultValidator">defaultValidator</a></div><div class="sidebar-section-children"><a href="global.html#enumNormalizer">enumNormalizer</a></div><div class="sidebar-section-children"><a href="global.html#getDefaultInstance">getDefaultInstance</a></div><div class="sidebar-section-children"><a href="global.html#getFieldElementType">getFieldElementType</a></div><div class="sidebar-section-children"><a href="global.html#getFieldType">getFieldType</a></div><div class="sidebar-section-children"><a href="global.html#getSourceField">getSourceField</a></div><div class="sidebar-section-children"><a href="global.html#hasOwnProperty">hasOwnProperty</a></div><div class="sidebar-section-children"><a href="global.html#hasProperty">hasProperty</a></div><div class="sidebar-section-children"><a href="global.html#hasPrototypeFunction">hasPrototypeFunction</a></div><div class="sidebar-section-children"><a href="global.html#isEnumClass">isEnumClass</a></div><div class="sidebar-section-children"><a href="global.html#isEnumerator">isEnumerator</a></div><div class="sidebar-section-children"><a href="global.html#isValidPageSource">isValidPageSource</a></div><div class="sidebar-section-children"><a href="global.html#normalize">normalize</a></div><div class="sidebar-section-children"><a href="global.html#stringifyId">stringifyId</a></div><div class="sidebar-section-children"><a href="global.html#toJSON">toJSON</a></div><div class="sidebar-section-children"><a href="global.html#toJsonString">toJsonString</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>
|
|
115
|
+
</code></pre><p>That is, the name of the enumerator is exactly its value.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>参数:</strong><table class="params"><thead><tr><th>名称</th><th>类型</th><th class="last">描述</th></tr></thead><tbody><tr><td class="name"><code>Class</code></td><td class="type"><span class="param-type">function</span></td><td class="description last"><p>The constructor of the class being decorated.</p></td></tr><tr><td class="name"><code>context</code></td><td class="type"><span class="param-type">object</span></td><td class="description last"><p>The context object containing information about the class being decorated.</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-author bold">作者</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl></div><h2 id="methods" class="subsection-title has-anchor">方法</h2><h3 class="name has-anchor" id=".Class.has"><span class="type-signature">(static) </span>Class.has<span class="signature">(expr)</span><span class="type-signature"> → {boolean}</span></h3><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><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>参数:</strong><table class="params"><thead><tr><th>名称</th><th>类型</th><th class="last">描述</th></tr></thead><tbody><tr><td class="name"><code>expr</code></td><td class="type"><span class="param-type">object</span> |<wbr> <span class="param-type">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">作者</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>返回值:</strong><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><dl class="param-type"><dt>类型: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id=".Class.hasCode"><span class="type-signature">(static) </span>Class.hasCode<span class="signature">(code)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Tests whether there is an enumerator of this enumeration class which has the specified code.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>参数:</strong><table class="params"><thead><tr><th>名称</th><th>类型</th><th class="last">描述</th></tr></thead><tbody><tr><td class="name"><code>code</code></td><td class="type"><span class="param-type">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">作者</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>返回值:</strong><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><dl class="param-type"><dt>类型: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id=".Class.hasName"><span class="type-signature">(static) </span>Class.hasName<span class="signature">(name)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Tests whether there is an enumerator of this enumeration class which has the specified name.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>参数:</strong><table class="params"><thead><tr><th>名称</th><th>类型</th><th class="last">描述</th></tr></thead><tbody><tr><td class="name"><code>name</code></td><td class="type"><span class="param-type">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">作者</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>返回值:</strong><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><dl class="param-type"><dt>类型: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id=".Class.hasValue"><span class="type-signature">(static) </span>Class.hasValue<span class="signature">(value)</span><span class="type-signature"> → {boolean}</span></h3><div class="description"><p>Tests whether there is an enumerator of this enumeration class which has the specified value.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>参数:</strong><table class="params"><thead><tr><th>名称</th><th>类型</th><th class="last">描述</th></tr></thead><tbody><tr><td class="name"><code>value</code></td><td class="type"><span class="param-type">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">作者</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>返回值:</strong><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><dl class="param-type"><dt>类型: </dt><dd><span class="param-type">boolean</span></dd></dl></div><h3 class="name has-anchor" id=".Class.of"><span class="type-signature">(static) </span>Class.of<span class="signature">(expr)</span><span class="type-signature"> → {undefined|object}</span></h3><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><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>参数:</strong><table class="params"><thead><tr><th>名称</th><th>类型</th><th class="last">描述</th></tr></thead><tbody><tr><td class="name"><code>expr</code></td><td class="type"><span class="param-type">object</span> |<wbr> <span class="param-type">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">作者</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>返回值:</strong><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><dl class="param-type"><dt>类型: </dt><dd><span class="param-type">undefined</span> |<wbr> <span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" id=".Class.ofCode"><span class="type-signature">(static) </span>Class.ofCode<span class="signature">(code)</span><span class="type-signature"> → {undefined|Class}</span></h3><div class="description"><p>Returns the enumerator of this enumeration class which has the specified code.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>参数:</strong><table class="params"><thead><tr><th>名称</th><th>类型</th><th class="last">描述</th></tr></thead><tbody><tr><td class="name"><code>code</code></td><td class="type"><span class="param-type">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">作者</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>返回值:</strong><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><dl class="param-type"><dt>类型: </dt><dd><span class="param-type">undefined</span> |<wbr> <span class="param-type">Class</span></dd></dl></div><h3 class="name has-anchor" id=".Class.ofName"><span class="type-signature">(static) </span>Class.ofName<span class="signature">(name)</span><span class="type-signature"> → {undefined|Class}</span></h3><div class="description"><p>Returns the enumerator of this enumeration class which has the specified name.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>参数:</strong><table class="params"><thead><tr><th>名称</th><th>类型</th><th class="last">描述</th></tr></thead><tbody><tr><td class="name"><code>name</code></td><td class="type"><span class="param-type">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">作者</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>返回值:</strong><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><dl class="param-type"><dt>类型: </dt><dd><span class="param-type">undefined</span> |<wbr> <span class="param-type">Class</span></dd></dl></div><h3 class="name has-anchor" id=".Class.ofValue"><span class="type-signature">(static) </span>Class.ofValue<span class="signature">(value)</span><span class="type-signature"> → {undefined|Class}</span></h3><div class="description"><p>Returns the enumerator of this enumeration class which has the specified value.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>参数:</strong><table class="params"><thead><tr><th>名称</th><th>类型</th><th class="last">描述</th></tr></thead><tbody><tr><td class="name"><code>value</code></td><td class="type"><span class="param-type">string</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><dl class="details"><div class="details-item-container"><dt class="tag-author bold">作者</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>返回值:</strong><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><dl class="param-type"><dt>类型: </dt><dd><span class="param-type">undefined</span> |<wbr> <span class="param-type">Class</span></dd></dl></div><h3 class="name has-anchor" id=".Class.values"><span class="type-signature">(static) </span>Class.values<span class="signature">()</span><span class="type-signature"> → {Array.<object>}</span></h3><div class="description"><p>Returns the array of all enumerators of this enumeration class.</p></div><div class="method-member-container mt-20"><strong>返回值:</strong><div class="param-desc"><p>The array of all enumerators of this enumeration class.</p></div><dl class="param-type"><dt>类型: </dt><dd><span class="param-type">Array.<object></span></dd></dl></div></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="关闭搜索"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="搜索..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">输入任何内容查看搜索结果</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><div class="mobile-nav-links"></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title"><a href="index.html" class="sidebar-home-anchor">首页</a></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-类"><div>类</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="DefaultAssignmentOptions.html">DefaultAssignmentOptions</a></div><div class="sidebar-section-children"><a href="DefaultOptions.html">DefaultOptions</a></div><div class="sidebar-section-children"><a href="DefaultToJsonOptions.html">DefaultToJsonOptions</a></div><div class="sidebar-section-children"><a href="Page.html">Page</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-命名空间"><div>命名空间</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Enum.html">Enum</a></div><div class="sidebar-section-children"><a href="Model.html">Model</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-全局"><div>全局</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#ElementType">ElementType</a></div><div class="sidebar-section-children"><a href="global.html#Label">Label</a></div><div class="sidebar-section-children"><a href="global.html#NameField">NameField</a></div><div class="sidebar-section-children"><a href="global.html#NonEmpty">NonEmpty</a></div><div class="sidebar-section-children"><a href="global.html#Normalizable">Normalizable</a></div><div class="sidebar-section-children"><a href="global.html#Nullable">Nullable</a></div><div class="sidebar-section-children"><a href="global.html#Readonly">Readonly</a></div><div class="sidebar-section-children"><a href="global.html#Timeout">Timeout</a></div><div class="sidebar-section-children"><a href="global.html#Type">Type</a></div><div class="sidebar-section-children"><a href="global.html#Validatable">Validatable</a></div><div class="sidebar-section-children"><a href="global.html#assign">assign</a></div><div class="sidebar-section-children"><a href="global.html#create">create</a></div><div class="sidebar-section-children"><a href="global.html#createArray">createArray</a></div><div class="sidebar-section-children"><a href="global.html#createDeferredReadonlyInitializer">createDeferredReadonlyInitializer</a></div><div class="sidebar-section-children"><a href="global.html#createImmediateReadonlyInitializer">createImmediateReadonlyInitializer</a></div><div class="sidebar-section-children"><a href="global.html#createPage">createPage</a></div><div class="sidebar-section-children"><a href="global.html#defaultNormalizer">defaultNormalizer</a></div><div class="sidebar-section-children"><a href="global.html#defaultValidator">defaultValidator</a></div><div class="sidebar-section-children"><a href="global.html#enumNormalizer">enumNormalizer</a></div><div class="sidebar-section-children"><a href="global.html#getDefaultInstance">getDefaultInstance</a></div><div class="sidebar-section-children"><a href="global.html#getFieldElementType">getFieldElementType</a></div><div class="sidebar-section-children"><a href="global.html#getFieldType">getFieldType</a></div><div class="sidebar-section-children"><a href="global.html#getSourceField">getSourceField</a></div><div class="sidebar-section-children"><a href="global.html#hasOwnProperty">hasOwnProperty</a></div><div class="sidebar-section-children"><a href="global.html#hasProperty">hasProperty</a></div><div class="sidebar-section-children"><a href="global.html#hasPrototypeFunction">hasPrototypeFunction</a></div><div class="sidebar-section-children"><a href="global.html#isEnumClass">isEnumClass</a></div><div class="sidebar-section-children"><a href="global.html#isEnumerator">isEnumerator</a></div><div class="sidebar-section-children"><a href="global.html#isValidPageSource">isValidPageSource</a></div><div class="sidebar-section-children"><a href="global.html#normalize">normalize</a></div><div class="sidebar-section-children"><a href="global.html#stringifyId">stringifyId</a></div><div class="sidebar-section-children"><a href="global.html#toJSON">toJSON</a></div><div class="sidebar-section-children"><a href="global.html#toJsonString">toJsonString</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button home-button" aria-label="go-to-homepage"><svg><use xlink:href="#home-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script><script>document.addEventListener("DOMContentLoaded",(function(){"undefined"!=typeof tippy&&(tippy(".home-button",{content:"回到首页",delay:500}),tippy(".theme-toggle",{content:"切换主题",delay:500}),tippy(".search-button",{content:"搜索",delay:500}),tippy(".font-size",{content:"更改字体大小",delay:500}))}))</script></body></html>
|