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/index.html ADDED Viewed

@@ -0,0 +1,1325 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Home - 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">
+    <section class="readme">
+        <article><h1>js-common-decorator</h1>
+<p><a href="https://npmjs.com/package/@qubit-ltd/common-decorator"><img src="https://img.shields.io/npm/v/@qubit-ltd/common-decorator.svg" alt="npm package"></a>
+<a href="https://www.apache.org/licenses/LICENSE-2.0"><img src="https://img.shields.io/badge/License-Apache-blue.svg" alt="License"></a>
+<a href="README.zh_CN.md"><img src="https://img.shields.io/badge/%E6%96%87%E6%A1%A3-%E4%B8%AD%E6%96%87%E7%89%88-blue.svg" alt="中文文档"></a>
+<a href="https://dl.circleci.com/status-badge/redirect/gh/Haixing-Hu/js-common-decorator/tree/master"><img src="https://dl.circleci.com/status-badge/img/gh/Haixing-Hu/js-common-decorator/tree/master.svg?style=shield" alt="CircleCI"></a>
+<a href="https://coveralls.io/github/Haixing-Hu/js-common-decorator?branch=master"><img src="https://coveralls.io/repos/github/Haixing-Hu/js-common-decorator/badge.svg?branch=master" alt="Coverage Status"></a></p>
+<p><a href="https://npmjs.com/package/@qubit-ltd/common-decorator">@qubit-ltd/common-decorator</a> is a JavaScript library of common decorators,
+provides decorators to add common methods to domain classes. The library
+supports the most recent (currently May 2023)
+<a href="https://github.com/tc39/proposal-decorators">stage 3 proposal of JavaScript decorators</a>.</p>
+<h2><span id="content">Table of Contents</span></h2>
+<ul>
+<li><a href="#usage">Usage</a>
+<ul>
+<li><a href="#model">@Model Decorator</a>
+<ul>
+<li><a href="#model-assign">Instance method: Class.prototype.assign(obj, options = undefined)</a></li>
+<li><a href="#model-clone">Instance method: Class.prototype.clone()</a></li>
+<li><a href="#model-isEmpty">Instance method: Class.prototype.isEmpty()</a></li>
+<li><a href="#model-clear">Instance method: Class.prototype.clear()</a></li>
+<li><a href="#model-equals">Instance method: Class.prototype.equals(other)</a></li>
+<li><a href="#model-generateId">Instance method: Class.prototype.generateId()</a></li>
+<li><a href="#model-normalizeField">Instance method: Class.prototype.normalizeField(field)</a></li>
+<li><a href="#model-normalize">Instance method: Class.prototype.normalize(fields)</a></li>
+<li><a href="#model-validateField">Instance method: Class.prototype.validateField(field)</a></li>
+<li><a href="#model-validate">Instance method: Class.prototype.validate(fields)</a></li>
+<li><a href="#model-toJSON">Instance method: Class.prototype.toJSON(key, options = undefined)</a></li>
+<li><a href="#model-toJsonString">Instance method: Class.prototype.toJsonString(options = undeinfed)</a></li>
+<li><a href="#model-create">Class method: Class.create(obj, options = undefined)</a></li>
+<li><a href="#model-createArray">Class method: Class.createArray(array, options = undefined)</a></li>
+<li><a href="#model-createPage">Class method: Class.createPage(page, options = undefined)</a></li>
+<li><a href="#model-isNullishOrEmpty">Class method: Class.isNullishOrEmpty()</a></li>
+<li><a href="#model-parseJsonString">Class method: Class.parseJsonString(json, options=undefined)</a></li>
+<li><a href="#model-usage-examples">Usage Examples</a></li>
+</ul>
+</li>
+<li><a href="#enum">@Enum Decorator</a>
+<ul>
+<li><a href="#enum-fields">Enumerator Fields</a></li>
+<li><a href="#enum-toString">Instance method: Class.prototype.toString()</a></li>
+<li><a href="#enum-toJSON">Instance method: Class.prototype.toJSON()</a></li>
+<li><a href="#enum-values">Class method: Class.values()</a></li>
+<li><a href="#enum-ofValue">Class method: Class.ofValue(value)</a></li>
+<li><a href="#enum-hasValue">Class method: Class.hasValue(value)</a></li>
+<li><a href="#enum-ofName">Class method: Class.ofName(name)</a></li>
+<li><a href="#enum-hasName">Class method: Class.hasName(name)</a></li>
+<li><a href="#enum-ofCode">Class method: Class.ofCode(code)</a></li>
+<li><a href="#enum-hasCode">Class method: Class.hasCode(code)</a></li>
+<li><a href="#enum-of">Class method: Class.of(expr)</a></li>
+<li><a href="#enum-has">Class method: Class.has(expr)</a></li>
+<li><a href="#enum-usage-example">Usage Example</a></li>
+</ul>
+</li>
+<li><a href="#default-options">DefaultOptions Class</a>
+<ul>
+<li><a href="#default-options-get">Class method: DefaultOptions.get(name)</a></li>
+<li><a href="#default-options-set">Class method: DefaultOptions.set(name, options)</a></li>
+<li><a href="#default-options-merge">Class method: DefaultOptions.merge(name, options)</a></li>
+</ul>
+</li>
+</ul>
+</li>
+<li><a href="#configuration">Configuration</a>
+<ul>
+<li><a href="#webpack">Bundling with webpack</a></li>
+<li><a href="#vite">Bundling with vite</a></li>
+</ul>
+</li>
+<li><a href="#contributing">Contributing</a></li>
+<li><a href="#license">License</a></li>
+</ul>
+<h2><span id="usage">Usage</span></h2>
+<h3><span id="model">@Model Decorator</span></h3>
+<p>This decorator is used to decorate a domain model class, which adds the
+following instance and class methods to the decorated class.</p>
+<p><strong>NOTE:</strong> If the decorated class already implements any of the following methods,
+this decorator will not override the methods already implemented by the decorated
+class.</p>
+<h4><span id="model-assign">Instance method: Class.prototype.assign(obj, options = undefined)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>obj: object</code>: the object whose fields will be copied to this object,
+which may have a different prototype to this object.</li>
+<li><code>options: null|undefined|object</code>: the additional options for the assignment.
+If this argument is <code>undefined</code> or <code>null</code>, the default options will be used.
+The default options can be retrieved by calling <code>DefaultOptions.get('assign')</code>.
+Available options are:
+<ul>
+<li><code>normalize: boolean</code>, indicates whether to normalize this object
+after the assignment. The default value is <code>true</code>.</li>
+<li><code>convertNaming: boolean</code>, indicates whether to convert the naming
+style of the target object. The default value is <code>false</code>.</li>
+<li><code>sourceNamingStyle: string</code>, the naming style of the source object,
+i.e., the first argument of the <code>assign()</code> method. The default value
+of this argument is <code>'LOWER_UNDERSCORE'</code>.</li>
+<li><code>targetNamingStyle: string</code>, the naming style of the target object,
+i.e., the object calling the <code>assign()</code> method. The default value
+of this argument is <code>'LOWER_CAMEL'</code>.</li>
+<li><code>types: object</code>, the additional information about types of fields of
+classes. The keys of this object are the path of the fields or
+sub-fields of the target object, the values are the type of the
+fields, represented as the constructor function of the type.
+The default value is <code>{}</code>.</li>
+<li><code>elementTypes: object</code>, the additional information about types of
+elements of fields of classes. The keys of this object are the path of
+the fields or sub-fields of the target object, the values are the type
+of the elements, represented as the constructor function of the type.
+The default value is <code>{}</code>.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>object</code>: the calling object itself.</li>
+</ul>
+</li>
+</ul>
+<p>This function copies the fields of the object <code>obj</code> to this object, only copying
+fields defined in this object's class. If a field in the <code>obj</code> object is
+<code>undefined</code> or <code>null</code>, it sets the field's value to the default value. Note that
+<code>obj</code> can have a different prototype to this object.</p>
+<h4><span id="model-clone">Instance method: Class.prototype.clone()</span></h4>
+<ul>
+<li>Parameters: none.</li>
+<li>Returns:
+<ul>
+<li><code>object</code>: a instance of the specified class deep cloned from the calling
+object.</li>
+</ul>
+</li>
+</ul>
+<p>This function deep clones the calling object, returning a new instance of the
+specified class with the same property values as the calling object. Note that
+the returned object has the same prototype as the calling object.</p>
+<h4><span id="model-clear">Instance method: Class.prototype.clear()</span></h4>
+<ul>
+<li>Parameters: none.</li>
+<li>Returns:
+<ul>
+<li><code>object</code>: the calling object itself.</li>
+</ul>
+</li>
+</ul>
+<p>This function sets all the properties of this object to their default values.
+The default value of a field is the value of the field of the default
+constructed instance of the class.</p>
+<h4><span id="model-isEmpty">Instance method: Class.prototype.isEmpty()</span></h4>
+<ul>
+<li>Parameters: none.</li>
+<li>Returns:
+<ul>
+<li><code>boolean</code>: whether this object is empty.</li>
+</ul>
+</li>
+</ul>
+<p>This function checks if this object is empty, meaning that all of its fields
+have default values. The default value of a field is the value of the field of
+the default constructed instance of the class.</p>
+<h4><span id="model-equals">Instance method: Class.prototype.equals(other)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>other: object</code>: the object to be compared with this object.</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>boolean</code>: whether this object is deeply equal to <code>other</code>.</li>
+</ul>
+</li>
+</ul>
+<p>This function checks whether this object is deeply equal to <code>other</code>. Two objects
+are deeply equal if and only if they have the same prototype, and all of their
+fields are deeply equal. Two fields are deeply equal if and only if they have
+the same value, or they are both <code>undefined</code> or <code>null</code>. If a field is an array,
+it is deeply equal to another array if and only if they have the same length,
+and all of their elements are deeply equal. If a field is an object, it is
+deeply equal to another object if and only if they have the same prototype,
+and all of their fields are deeply equal.</p>
+<h4><span id="model-generateId">Instance method: Class.prototype.generateId()</span></h4>
+<ul>
+<li>Parameters: none.</li>
+<li>Returns:
+<ul>
+<li><code>string</code>: the string representation of the generated globally unique ID set
+to the calling object.</li>
+</ul>
+</li>
+</ul>
+<p>If the decorated class defines a property named <code>id</code>, this instance method
+<code>generateId()</code> is automatically added to the decorated class. Each call to this
+method generates a globally unique ID for the current calling object
+(represented as a string of an integer), sets the <code>id</code> field of the calling
+object to the generated ID, and returns the generated ID. Note that if a parent
+class <code>A</code> defines the <code>id</code> field, and a subclass <code>B</code> inherits the <code>id</code> field but
+does not define its own <code>id</code> field, the <code>generateId()</code> method is added only to
+class <code>A</code>, not to class <code>B</code>.</p>
+<h4><span id="model-normalizeField">Instance method: Class.prototype.normalizeField(field)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>field: string</code>: the name of the specified field to be normalized.</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>boolean</code>: whether the specified field was normalized.</li>
+</ul>
+</li>
+</ul>
+<p>This function normalizes the specified field of this object. If the object has
+the specified field and the specified field is normalizable, the function
+normalizes the specified field and returns <code>true</code>; otherwise, the function does
+nothing and returns <code>false</code>. Note that a field is normalizable if and only if it
+is decorated by the <code>@Normalizable</code> decorator.</p>
+<h4><span id="model-normalize">Instance method: Class.prototype.normalize(fields)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>fields: undefined | null | string | string[]</code>: the fields to be normalized.
+It can be one of the following values:
+<ul>
+<li><code>undefined</code>: normalizes all the normalizable fields of this object.</li>
+<li><code>null</code>: normalizes all the normalizable fields of this object.</li>
+<li><code>&quot;*&quot;</code>: normalizes all the normalizable fields of this object.</li>
+<li><code>string[]</code>: normalizes all the normalizable fields whose names are
+specified in this array.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>object</code>: the normalized calling object.</li>
+</ul>
+</li>
+</ul>
+<p>This function normalizes the specified fields of this object. The <code>fields</code>
+parameter specifies the names of fields to be normalized. If <code>fields</code> is
+<code>undefined</code>, <code>null</code>, or the string <code>&quot;*&quot;</code>, it normalizes all the normalizable
+fields of this object. If <code>fields</code> is an array of strings, it normalizes all the
+normalizable fields whose names are specified in the array. Note that a field is
+normalizable if and only if it is decorated by the <code>@Normalizable</code> decorator.</p>
+<h4><span id="model-validateField">Instance method: Class.prototype.validateField(field)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>field: string</code>: the name of the specified field to be validated.</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>ValidationResult | null</code>: the validation result.</li>
+</ul>
+</li>
+</ul>
+<p>This function validates the specified field of this object. If the object has
+the specified field and the specified field is validatable, the function
+validates the specified field and returns the validation result; otherwise, the
+function does nothing and returns <code>null</code>. Note that a field is validatable if
+and only if it is decorated by the <code>@Validatable</code> decorator.</p>
+<h4><span id="model-validate">Instance method: Class.prototype.validate(fields)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>fields: undefined | null | string | string[]</code>: the fields to be validated.
+It can be one of the following values:
+<ul>
+<li><code>undefined</code>: validates all the validatable fields of this object.</li>
+<li><code>null</code>: validates all the validatable fields of this object.</li>
+<li><code>&quot;*&quot;</code>: validates all the validatable fields of this object.</li>
+<li><code>string[]</code>: validates all the validatable fields whose names are
+specified in this array.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>ValidationResult</code>: the validation result.</li>
+</ul>
+</li>
+</ul>
+<p>This function validates the specified fields of this object. The <code>fields</code>
+parameter specifies the names of fields to be validated. If <code>fields</code> is
+<code>undefined</code>, <code>null</code>, or the string <code>&quot;*&quot;</code>, it validates all the validatable
+fields of this object. If <code>fields</code> is an array of strings, it validates all the
+validatable fields whose names are specified in the array. Note that a field is
+validatable if and only if it is decorated by the <code>@Validatable</code>
+decorator.</p>
+<h4><span id="model-toJSON">Instance method: Class.prototype.toJSON(key, options = undefined)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>key: string</code>:<code>JSON.stringify()</code> calls <code>toJSON()</code> with one parameter,
+the <code>key</code>,which takes the following values:
+<ul>
+<li>if this object is a property value, this argument is the property
+name;</li>
+<li>if this object is in an array, this argument is the index in the
+array, as a string;</li>
+<li>if <code>JSON.stringify()</code> was directly called on this object, this
+argument is an empty string.</li>
+</ul>
+</li>
+<li><code>options: null|undefined|object</code>: the additional options for the
+serialization. If this argument is <code>undefined</code> or <code>null</code>, the default
+options will be used. The default options can be retrieved by calling
+<code>DefaultOptions.get('toJSON')</code>. Available options are:
+<ul>
+<li><code>normalize: boolean</code>, indicates whether to normalize this object
+before serializing. The default value is <code>true</code>.</li>
+<li><code>removeEmptyFields: boolean</code>, indicates whether to ignore the empty
+fields of the object. If it is <code>true</code>, the empty fields of the object
+will be removed before serialization. The default value is <code>false</code>.</li>
+<li><code>convertNaming: boolean</code>, indicates whether to convert the naming
+of properties of the object represented by the result JSON string.
+The default value is <code>false</code>.</li>
+<li><code>sourceNamingStyle: string</code>, the naming style of the source object,
+i.e., the object calling the <code>toJSON()</code> method. The default value
+of this argument is <code>'LOWER_CAMEL'</code>.</li>
+<li><code>targetNamingStyle: string</code>, the naming style of the target object,
+i.e., the object represented by the result JSON string of the
+<code>toJSON()</code> method. The default value of this argument is
+<code>'LOWER_UNDERSCORE'</code>.</li>
+<li><code>space: string | number</code>, a string or number that's used to insert
+white space (including indentation, line break characters, etc.) into
+the output JSON string for readability purposes. If this is a number,
+it indicates the number of space characters to be used as indentation,
+clamped to 10 (that is, any number greater than 10 is treated as if
+it were 10). Values less than 1 indicate that no space should be used.
+If this is a string, the string (or the first 10 characters of the
+string, if it's longer than that) is inserted before every nested
+object or array. If this is anything other than a string or number
+(can be either a primitive or a wrapper object) — for example, is
+<code>null</code> or not provided — no white space is used. The default value
+of this option is <code>null</code>.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>object</code>: the object to be serialized by <code>JSON.stringify()</code>, which may be
+a modify copy of this object.</li>
+</ul>
+</li>
+</ul>
+<p>This function gets the object to be serialized by <code>JSON.stringify()</code>.
+If the value has a <code>toJSON()</code> method, it's responsible to define what
+data will be serialized. Instead of the object being serialized, the value
+returned by the <code>toJSON()</code> method when called will be serialized.</p>
+<p><strong>NOTE:</strong> this function returns an object to be serialized by
+<code>JSON.stringify()</code>, instead of a JSON string. Use <code>JSON.stringify()</code>
+or <code>this.toJsonString()</code> methods to serialize this object into a JSON
+string.</p>
+<h4><span id="model-toJsonString">Instance method: Class.prototype.toJsonString(options = undefined)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>options: null|undefined|object</code>: the additional options for the
+serialization. If this argument is <code>undefined</code> or <code>null</code>, the default
+options will be used. The default options can be retrieved by calling
+<code>DefaultOptions.get('toJSON')</code>. Available options are:
+<ul>
+<li><code>normalize: boolean</code>, indicates whether to normalize this object
+before serializing. The default value is <code>true</code>.</li>
+<li><code>removeEmptyFields: boolean</code>, indicates whether to ignore the empty
+fields of the object. If it is <code>true</code>, the empty fields of the object
+will be removed before serialization. The default value is <code>false</code>.</li>
+<li><code>convertNaming: boolean</code>, indicates whether to convert the naming
+of properties of the object represented by the result JSON string.
+The default value is <code>false</code>.</li>
+<li><code>sourceNamingStyle: string</code>, the naming style of the source object,
+i.e., the object calling the <code>toJSON()</code> method. The default value
+of this argument is <code>'LOWER_CAMEL'</code>.</li>
+<li><code>targetNamingStyle: string</code>, the naming style of the target object,
+i.e., the object represented by the result JSON string of the
+<code>toJSON()</code> method. The default value of this argument is
+<code>'LOWER_UNDERSCORE'</code>.</li>
+<li><code>space: string | number</code>, a string or number that's used to insert
+white space (including indentation, line break characters, etc.) into
+the output JSON string for readability purposes. If this is a number,
+it indicates the number of space characters to be used as indentation,
+clamped to 10 (that is, any number greater than 10 is treated as if
+it were 10). Values less than 1 indicate that no space should be used.
+If this is a string, the string (or the first 10 characters of the
+string, if it's longer than that) is inserted before every nested
+object or array. If this is anything other than a string or number
+(can be either a primitive or a wrapper object) — for example, is
+<code>null</code> or not provided — no white space is used. The default value
+of this option is <code>null</code>.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>string</code>: the JSON string serialized from this object, as <code>JSON.stringify()</code>
+does, except that this function provides additional stringification
+options.</li>
+</ul>
+</li>
+</ul>
+<p>This function serializes this object into a JSON string.</p>
+<p><strong>NOTE:</strong> This method supports native <code>bigint</code> value. For example, the
+<code>bigint</code> value <code>9223372036854775807n</code> will be stringify as
+<code>9223372036854775807</code>.</p>
+<h4><span id="model-create">Class method: Class.create(obj, options = undefined)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>obj: object</code>: the data object used to create the new instance.</li>
+<li><code>options: null|undefined|object</code>: the additional options for the creation.
+If this argument is <code>undefined</code> or <code>null</code>, the default options will be used.
+The default options can be retrieved by calling <code>DefaultOptions.get('assign')</code>.
+Available options are:
+<ul>
+<li><code>normalize: boolean</code>, indicates whether to normalize this object
+after the assignment. The default value is <code>true</code>.</li>
+<li><code>convertNaming: boolean</code>, indicates whether to convert the naming
+style of the target object. The default value is <code>false</code>.</li>
+<li><code>sourceNamingStyle: string</code>, the naming style of the source object,
+i.e., the first argument of the <code>create()</code> method. The default
+value of this argument is <code>'LOWER_UNDERSCORE'</code>.</li>
+<li><code>targetNamingStyle: string</code>, the naming style of the target object,
+i.e., the object returned by the <code>create()</code> method. The default
+value of this argument is <code>'LOWER_CAMEL'</code>.</li>
+<li><code>types: object</code>, the additional information about types of
+fields of classes. The keys of this object are the path of the fields
+or sub-fields of the target object, the values are the type of the
+fields, represented as the constructor function of the type.
+The default value is <code>{}</code>.</li>
+<li><code>elementTypes: object</code>, the additional information about types of
+elements of fields of classes. The keys of this object are the path of
+the fields or sub-fields of the target object, the values are the type
+of the elements, represented as the constructor function of the type.
+The default value is <code>{}</code>.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>object | null</code>: if the <code>obj</code> is <code>undefined</code> or <code>null</code>, returns <code>null</code>;
+otherwise, returns a new instance of the model class whose fields are
+initialized with the data in the <code>obj</code>.</li>
+</ul>
+</li>
+</ul>
+<p>This function creates a instance of the specified class from a data object,
+whose fields are recursively initialized with properties in the <code>obj</code>. Note that
+<code>obj</code> can have a different prototype to the specified class.</p>
+<h4><span id="model-createArray">Class method: Class.createArray(array, options = undefined)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>array: object[]</code>: the data object array used to create the new array.</li>
+<li><code>options: null|undefined|object</code>: the additional options for the creation.
+If this argument is <code>undefined</code> or <code>null</code>, the default options will be used.
+The default options can be retrieved by calling <code>DefaultOptions.get('assign')</code>.
+Available options are:
+<ul>
+<li><code>normalize: boolean</code>, indicates whether to normalize this object
+after the assignment. The default value is <code>true</code>.</li>
+<li><code>convertNaming: boolean</code>, indicates whether to convert the naming
+style of the target object. The default value is <code>false</code>.</li>
+<li><code>sourceNamingStyle: string</code>, the naming style of the source object,
+i.e., the elements in the first argument of the <code>createArray()</code>
+method. The default value of this argument is <code>'LOWER_UNDERSCORE'</code>.</li>
+<li><code>targetNamingStyle: string</code>, the naming style of the target object,
+i.e., the elements in the array returned by the <code>createArray()</code>
+method. The default value of this argument is <code>'LOWER_CAMEL'</code>.</li>
+<li><code>types: object</code>, the additional information about types of
+fields of classes. The keys of this object are the path of the fields
+or sub-fields of the target object, the values are the type of the
+fields, represented as the constructor function of the type.
+The default value is <code>{}</code>.</li>
+<li><code>elementTypes: object</code>, the additional information about types of
+elements of fields of classes. The keys of this object are the path of
+the fields or sub-fields of the target object, the values are the type
+of the elements, represented as the constructor function of the type.
+The default value is <code>{}</code>.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>object[] | null</code>: if the <code>array</code> is <code>undefined</code> or <code>null</code>, returns <code>null</code>;
+otherwise, returns a new array of instances of the model class whose
+fields are initialized with corresponding data object in the <code>array</code>.</li>
+</ul>
+</li>
+</ul>
+<p>This function creates an array of instances of the specified class from a data
+object array. The fields of instances in the returned array are recursively
+initialized with corresponding properties of the corresponding data object in
+the <code>array</code>. Note that data objects in <code>array</code> can have different prototypes to
+the specified class.</p>
+<h4><span id="model-createPage">Class method: Class.createPage(page, options = undefined)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>page: object</code>: the pagination data object used to create the new <code>Page</code>
+instance.</li>
+<li><code>options: null|undefined|object</code>: the additional options for the creation.
+If this argument is <code>undefined</code> or <code>null</code>, the default options will be used.
+The default options can be retrieved by calling <code>DefaultOptions.get('assign')</code>.
+Available options are:
+<ul>
+<li><code>normalize: boolean</code>, indicates whether to normalize this object
+after the assignment. The default value is <code>true</code>.</li>
+<li><code>convertNaming: boolean</code>, indicates whether to convert the naming
+style of the target object. The default value is <code>false</code>.</li>
+<li><code>sourceNamingStyle: string</code>, the naming style of the source object,
+i.e., the elements in the <code>content</code> array of the first argument of
+the <code>createPage()</code> method. The default value of this argument is
+<code>'LOWER_UNDERSCORE'</code>.</li>
+<li><code>targetNamingStyle: string</code>, the naming style of the target object,
+i.e., the elements in the <code>content</code> array of the <code>Page</code> object
+returned by the <code>createPage()</code> method. The default value of this
+argument is <code>'LOWER_CAMEL'</code>.</li>
+<li><code>types: object</code>, the additional information about types of
+fields of classes. The keys of this object are the path of the fields
+or sub-fields of the target object, the values are the type of the
+fields, represented as the constructor function of the type.
+The default value is <code>{}</code>.</li>
+<li><code>elementTypes: object</code>, the additional information about types of
+elements of fields of classes. The keys of this object are the path of
+the fields or sub-fields of the target object, the values are the type
+of the elements, represented as the constructor function of the type.
+The default value is <code>{}</code>.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>Page | null</code>: if the <code>page</code> is <code>undefined</code> or <code>null</code>, returns <code>null</code>;
+otherwise, returns a new instance of the <code>Page</code> class whose content are
+initialized with the content of the pagination data object <code>page</code>.</li>
+</ul>
+</li>
+</ul>
+<p>This function creates a <code>Page</code> object, whose content are initialized with the
+content of the specified pagination data object. Typically, <code>page</code> is a list of
+domain objects obtained from a server using the <code>GET</code> method, and the object
+should conform to the <code>Page</code> class definition. This class method returns
+a new <code>Page</code> object, with the <code>content</code> property being the result of
+<code>createArray(page.content, options)</code>, and the other properties matching those of
+the <code>page</code> object. If <code>page</code> is not a valid <code>Page</code> object, it returns <code>null</code>.</p>
+<h4><span id="model-isNullishOrEmpty">Class method: Class.isNullishOrEmpty(obj)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>obj: object</code>: the object to be checked.</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>boolean</code>: whether the specified object is <code>undefined</code>, <code>null</code>, or an
+empty object constructed with default values.</li>
+</ul>
+</li>
+</ul>
+<p>This function checks whether the specified object is <code>undefined</code>, <code>null</code>, or an
+empty object constructed with default values. An object is empty if and only if
+all of its fields have default values. The default value of a field is the value
+of the field of the default constructed instance of the class. This function is
+a convenient method to call <code>Class.prototype.isEmpty()</code>, with the handling of
+nullish values.</p>
+<h4><span id="model-parseJsonString">Class method: Class.parseJsonString(json, options = undefined)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>json: string</code>: the JSON string to be parsed.</li>
+<li><code>options: null|undefined|object</code>: the additional options for the parsing.
+If this argument is <code>undefined</code> or <code>null</code>, the default options will be used.
+The default options can be retrieved by calling <code>DefaultOptions.get('assign')</code>.
+Available options are:
+<ul>
+<li><code>normalize: boolean</code>, indicates whether to normalize this object
+after the assignment. The default value is <code>true</code>.</li>
+<li><code>convertNaming: boolean</code>, indicates whether to convert the naming
+style of properties of the object represented by the JSON string.
+The default value is <code>false</code>.</li>
+<li><code>sourceNamingStyle: string</code>, the naming style of the source object,
+i.e., the object represented by the JSON string. The default value
+of this argument is <code>'LOWER_UNDERSCORE'</code>.</li>
+<li><code>targetNamingStyle: string</code>, the naming style of the target object,
+i.e., the object returned by the <code>parseJsonString()</code> method. The
+default value of this argument is <code>'LOWER_CAMEL'</code>.</li>
+</ul>
+</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>boolean</code>: whether the specified object is <code>undefined</code>, <code>null</code>, or an
+empty object constructed with default values.</li>
+</ul>
+</li>
+</ul>
+<p>This function parses an object of this class from a JSON string.</p>
+<p><strong>NOTE:</strong> This method supports integer values fall out of IEEE 754 integer
+precision. For example, the integer value <code>9223372036854775807</code> will be
+parsed as the native <code>bigint</code> value <code>9223372036854775807n</code>.</p>
+<h4><span id="model-usage-examples">Usage Examples</span></h4>
+<p>The following is the usage example of the <code>@Model</code> decorator.</p>
+<pre class="prettyprint source lang-js"><code>@Model
+class Credential {
+  @Normalizable
+  @Validator(validateCredentialTypeField)
+  @Type(CredentialType)
+  @Label('证件类型')
+  type = 'IDENTITY_CARD';
+  @Normalizable(trimUppercaseString)
+  @Validator(validateCredentialNumberField)
+  @Label('证件号码')
+  number = '';
+  constructor(type = CredentialType.DEFAULT.value, number = '') {
+    this.type = type;
+    this.number = number;
+  }
+  isIdentityCard() {
+    return (this.type === 'IDENTITY_CARD');
+  }
+}
+@Model
+class Person {
+  @Normalizable(trimString)
+  @Label('ID')
+  id = null;
+  @Normalizable(trimUppercaseString)
+  @Validator(validatePersonNameField)
+  @Label('姓名')
+  name = '';
+  @Normalizable
+  @DefaultValidator
+  @Type(Credential)
+  @Label('证件')
+  credential = null;
+  @Normalizable
+  @Validator(validatePersonGenderField)
+  @Type(Gender)
+  @Label('性别')
+  gender = '';
+  @Normalizable(trimString)
+  @Validator(validatePersonBirthdayField)
+  @Label('出生日期')
+  birthday = '';
+  @Normalizable(trimUppercaseString)
+  @Validator(validateMobileField)
+  @Label('手机号码')
+  mobile = '';
+  @Normalizable(trimString)
+  @Validator(validateEmailField)
+  @Label('电子邮件地址')
+  @Nullable
+  email = '';
+  equals(other) {
+    if (!(other instanceof PersonWithEquals)) {
+      return false;
+    }
+    if ((this.credential === null) || (other.credential === null)) {
+      // If one of the two people does not have ID inofmation, it is impossible
+      // to compare whether they are the same person thus they will be considered
+      // different.
+      return false;
+    }
+    // Two persons are logically equals if and only if they have the same
+    // credential.
+    return (this.credential.type === other.credential.type)
+        && (this.credential.number === other.credential.number);
+  }
+}
+</code></pre>
+<p>After applying the <code>@Model</code> decorator, the following methods will be automatically
+added:</p>
+<ul>
+<li><code>Credential.prototype.assign(obj, options = undefined)</code></li>
+<li><code>Credential.prototype.clear()</code></li>
+<li><code>Credential.prototype.clone()</code></li>
+<li><code>Credential.prototype.isEmpty()</code></li>
+<li><code>Credential.prototype.equals(obj)</code></li>
+<li><code>Credential.prototype.normalize(fields)</code></li>
+<li><code>Credential.prototype.validate(fields, options)</code></li>
+<li><code>Credential.prototype.toJSON(key, options = undefined)</code></li>
+<li><code>Credential.prototype.toJsonString(options = undefined)</code></li>
+<li><code>Credential.create(obj, options = undefined)</code></li>
+<li><code>Credential.createArray(array, options = undefined)</code></li>
+<li><code>Credential.createPage(page, options = undefined)</code></li>
+<li><code>Credential.isNullishOrEmpty(obj)</code></li>
+<li><code>Credential.parseJsonString(json, options = undefined)</code></li>
+<li><code>Person.prototype.assign(obj, normalized)</code></li>
+<li><code>Person.prototype.clear()</code></li>
+<li><code>Person.prototype.clone()</code></li>
+<li><code>Person.prototype.isEmpty()</code></li>
+<li><code>Person.prototype.normalize(fields)</code></li>
+<li><code>Person.prototype.validate(fields, options)</code></li>
+<li><code>Person.prototype.generateId()</code></li>
+<li><code>Person.prototype.toJSON(key, options = undefined)</code></li>
+<li><code>Person.prototype.toJsonString(options = undefined)</code></li>
+<li><code>Person.create(obj, options = undefined)</code></li>
+<li><code>Person.createArray(array, options = undefined)</code></li>
+<li><code>Person.createPage(page, options = undefined)</code></li>
+<li><code>Person.isNullishOrEmpty(obj)</code></li>
+<li><code>Person.parseJsonString(json, options = undefined)</code></li>
+<li></li>
+</ul>
+<p><strong>NOTE:</strong></p>
+<ul>
+<li>Because the <code>Credential</code> class does not have an <code>id</code> attribute, the <code>@Model</code>
+decorator does not add a <code>generateId()</code> instance method to it.</li>
+<li>Because <code>Person</code> already implements the <code>Person.prototype.equals()</code> method,
+the <code>@Model</code> decorator will <strong>not</strong> override its own implementation of
+the <code>Person.prototype.equals()</code> method.</li>
+</ul>
+<h3><span id="enum">@Enum Decorator</span></h3>
+<p>This decorator is used to decorate an enumeration class.</p>
+<h4><span id="enum-fields">Enumerator Fields</span></h4>
+<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>
+<h4><span id="enum-toString">Instance method: Class.prototype.toString()</span></h4>
+<ul>
+<li>Parameters: none.</li>
+<li>Returns:
+<ul>
+<li><code>string</code>: the string representation of this enumerator, which is the
+<code>value</code> of this enumerator.</li>
+</ul>
+</li>
+</ul>
+<p>This function returns the string representation of this enumerator, which is
+the <code>value</code> of this enumerator.</p>
+<h4><span id="enum-toJSON">Instance method: Class.prototype.toJSON()</span></h4>
+<ul>
+<li>Parameters: none.</li>
+<li>Returns:
+<ul>
+<li><code>string</code>: the JSON representation of this enumerator, which is the JSON
+string representation of the <code>value</code> of this enumerator, i.e., the double
+quoted string of the <code>value</code>.</li>
+</ul>
+</li>
+</ul>
+<p>This function returns the JSON representation of this enumerator.</p>
+<h4><span id="enum-values">Class method: Class.values()</span></h4>
+<ul>
+<li>Parameters: none.</li>
+<li>Returns:
+<ul>
+<li><code>Class[]</code>: the array of all enumerators of this enumeration class.</li>
+</ul>
+</li>
+</ul>
+<p>This function returns the array of all enumerators of this enumeration class.</p>
+<h4><span id="enum-ofValue">Class method: Class.ofValue(value)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>value: string</code>: the value of the enumerator to be returned. Note that this
+argument will be trimmed and uppercased to get the actual value of the
+enumerator.</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>Class</code>: the enumerator in this enumeration class with the specified value,
+or <code>undefined</code> if no such enumerator exists.</li>
+</ul>
+</li>
+</ul>
+<p>This function returns the enumerator with the specified value.</p>
+<h4><span id="enum-hasValue">Class method: Class.hasValue(value)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>value: string</code>: the value of the enumerator to be tested. Note that this
+argument will be trimmed and uppercased to get the actual value of the
+enumerator.</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>boolean</code>: returns <code>true</code> if there is an enumerator in this enumeration
+class with the specified value, or <code>false</code> otherwise.</li>
+</ul>
+</li>
+</ul>
+<p>This function tests whether there is an enumerator with the specified value.</p>
+<h4><span id="enum-ofName">Class method: Class.ofName(name)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>name: string</code>: the name of the enumerator to be returned.</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>Class</code>: the enumerator in this enumeration class with the specified name,
+or <code>undefined</code> if no such enumerator exists.</li>
+</ul>
+</li>
+</ul>
+<p>This function returns the enumerator with the specified name.</p>
+<h4><span id="enum-hasName">Class method: Class.hasName(name)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>name: string</code>: the name of the enumerator to be tested.</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>boolean</code>: returns <code>true</code> if there is an enumerator in this enumeration
+class with the specified name, or <code>false</code> otherwise.</li>
+</ul>
+</li>
+</ul>
+<p>This function tests whether there is an enumerator with the specified name.</p>
+<h4><span id="enum-ofCode">Class method: Class.ofCode(code)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>code: string</code>: the code of the enumerator to be returned.</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>Class</code>: the enumerator in this enumeration class with the specified code,
+or <code>undefined</code> if no such enumerator exists.</li>
+</ul>
+</li>
+</ul>
+<p>This function returns the enumerator with the specified value.</p>
+<h4><span id="enum-hasCode">Class method: Class.hasCode(code)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>code: string</code>: the code of the enumerator to be tested.</li>
+</ul>
+</li>
+<li>Returns:
+<ul>
+<li><code>boolean</code>: returns <code>true</code> if there is an enumerator in this enumeration
+class with the specified code, or <code>false</code> otherwise.</li>
+</ul>
+</li>
+</ul>
+<p>This function tests whether there is an enumerator with the specified code.</p>
+<h4><span id="enum-of">Class method: Class.of(expr)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>expr: object | string</code>: the expression corresponds to the enumerator to
+be returned. 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>
+</li>
+<li>Returns:
+<ul>
+<li><code>Class</code>: the enumerator in this enumeration class corresponds to the
+specified expression, or <code>undefined</code> if no such enumerator exists.</li>
+</ul>
+</li>
+</ul>
+<p>This function returns the enumerator with the specified value.</p>
+<h4><span id="enum-has">Class method: Class.has(expr)</span></h4>
+<ul>
+<li>Parameters:
+<ul>
+<li><code>expr: object | string</code>: the expression corresponds to the enumerator to
+be returned. 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>
+</li>
+<li>Returns:
+<ul>
+<li><code>boolean</code>: returns <code>true</code> if there is an enumerator in this enumeration
+class corresponds to the specified expression, or <code>false</code> otherwise.</li>
+</ul>
+</li>
+</ul>
+<p>This function tests whether there is an enumerator with the specified code.</p>
+<h4><span id="enum-usage-example">Usage Example</span></h4>
+<pre class="prettyprint source lang-js"><code>@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>@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>@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>
+<h3><span id="default-options"><code>DefaultOptions</code> class</span></h3>
+<p>The <code>DefaultOptions</code> class is used to get or set the default options of different
+aspects of this library.</p>
+<p>The class accesses an internal <code>Map</code> object. The key of the map is the name
+of aspects, and the value of the map is an object representing the default
+options of the aspect.</p>
+<p>For example, the default options of the <code>assign()</code> method of the class
+decorated by <code>@Model</code> is stored in the key <code>assign</code>. That is,
+<code>DefaultOption.get('assign')</code> returns the object representing the default
+options of the <code>assign()</code> method.</p>
+<p>The program can change the default options with <code>DefaultOptions.set('key', options)</code>
+method.</p>
+<p>Currently, the following aspects are supported:</p>
+<ul>
+<li><code>assign</code>: the default options of the <code>Class.prototype.assign()</code>,
+<code>Class.create()</code>, <code>Class.createArray()</code>, <code>Class.createPage()</code>,
+<code>Class.parseJsonString()</code> methods of  the class decorated by <code>@Model</code>.</li>
+<li><code>toJSON</code>: the default options of the <code>Class.prototype.toJSON()</code>,
+<code>Class.prototype.toJsonString()</code> methods of the class decorated by <code>@Model</code>.</li>
+</ul>
+<h4><span id="default-options-get">Class method: <code>DefaultOptions.get(aspect)</code></span></h4>
+<p>Gets the default options of the specified aspect.</p>
+<p>The function returns the object representing the default options of the aspect,
+or <code>undefined</code>if the aspect does not exist. Note that the returned object is a
+deep cloned copy of the object stored in the internal map, so that the
+modification of the returned object will <strong>not</strong> affect the default options
+stored in the internal map.</p>
+<pre class="prettyprint source lang-js"><code>import { DefaultOptions } from '@qubit-ltd/common-decorator';
+const opt1 = DefaultOptions.get('assign');
+expect(opt1.convertNaming).toBe(false);
+opt1.convertNaming = true;
+const opt2 = DefaultOptions.get('assign');
+expect(opt2.convertNaming).toBe(false);
+</code></pre>
+<h4><span id="default-options-set">Class method: <code>DefaultOptions.set(aspect, options)</code></span></h4>
+<p>Sets the default options of the specified aspect.</p>
+<p>This function will merge the new options into the old default options of the aspect.
+If the new options have the same property as the old default options stored
+in the internal map, the value of the new options will override the value of the
+old default options; otherwise, the new property will be added to the old default
+options.</p>
+<pre class="prettyprint source lang-js"><code>import { DefaultOptions } from '@qubit-ltd/common-decorator';
+const opt1 = DefaultOptions.get('assign');
+expect(opt1.convertNaming).toBe(false);
+DefaultOptions.set('assign', { convertNaming: true });
+const opt2 = DefaultOptions.get('assign');
+expect(opt2.convertNaming).toBe(true);
+expect(opt1.convertNaming).toBe(false);
+</code></pre>
+<h4><span id="default-options-merge">Class method: <code>DefaultOptions.merge(aspect, options)</code></span></h4>
+<p>Gets the default options of the specified aspect, merging the provided default
+options into the returned object.</p>
+<p><strong>NOTE:</strong> This function does <strong>NOT</strong> change the default options stored in the
+internal map, instead, it returns a new object representing the merged options.</p>
+<pre class="prettyprint source lang-js"><code>import { DefaultOptions } from '@qubit-ltd/common-decorator';
+const opt1 = DefaultOptions.get('assign');
+expect(opt1.convertNaming).toBe(false);
+const opt2 = DefaultOptions.merge('assign', { convertNaming: true });
+expect(opt2.convertNaming).toBe(true);
+expect(opt1.convertNaming).toBe(false);
+const opt3 = DefaultOptions.merge('assign', null);
+expect(opt3.convertNaming).toBe(false);
+</code></pre>
+<h2><span id="configuration">Configuration</span></h2>
+<p>This library uses the most recent (currently May 2023)
+<a href="https://github.com/tc39/proposal-decorators">stage 3 proposal of JavaScript decorators</a>. Therefore, you must configure
+<a href="https://babeljs.io/">Babel</a> with <a href="https://babeljs.io/docs/babel-plugin-transform-class-properties">@babel/plugin-transform-class-properties</a> and the
+<a href="https://babeljs.io/docs/babel-plugin-proposal-decorators">@babel/plugin-proposal-decorators</a> plugins.</p>
+<p><strong>NOTE:</strong> To support the <a href="https://github.com/tc39/proposal-decorator-metadata">stage 3 proposal of JavaScript decorator metadata</a>,
+the version of the <a href="https://babeljs.io/">Babel</a> plugin <a href="https://babeljs.io/docs/babel-plugin-proposal-decorators">@babel/plugin-proposal-decorators</a> must be
+at least <code>7.23.0</code>.</p>
+<h3><span id="webpack">Bundling with <a href="https://webpack.js.org/">webpack</a></span></h3>
+<ol>
+<li>Install the required dependencies:<pre class="prettyprint source lang-shell"><code>yarn add @qubit-ltd/common-decorator
+yarn add --dev @babel/core @babel/runtime @babel/preset-env
+yarn add --dev @babel/plugin-proposal-decorators @babel/plugin-transform-class-properties @babel/plugin-transform-runtime
+</code></pre>
+</li>
+<li>Configure <a href="https://babeljs.io/">Babel</a> by using the <a href="https://babeljs.io/docs/babel-plugin-transform-class-properties">@babel/plugin-transform-class-properties</a>
+and <a href="https://babeljs.io/docs/babel-plugin-proposal-decorators">@babel/plugin-proposal-decorators</a> plugins. A possible <a href="https://babeljs.io/">Babel</a>
+configuration file <code>babelrc.json</code> is as follows:<pre class="prettyprint source lang-json"><code>{
+  &quot;presets&quot;: [
+    &quot;@babel/preset-env&quot;
+  ],
+  &quot;plugins&quot;: [
+    &quot;@babel/plugin-transform-runtime&quot;,
+    [&quot;@babel/plugin-proposal-decorators&quot;, { &quot;version&quot;: &quot;2023-05&quot; }],
+    &quot;@babel/plugin-transform-class-properties&quot;
+  ]
+}
+</code></pre>
+</li>
+</ol>
+<h3><span id="vite">Bundling with <a href="https://vitejs.dev/">vite</a></span></h3>
+<ol>
+<li>Install the required dependencies:<pre class="prettyprint source lang-shell"><code>yarn add @qubit-ltd/common-decorator
+yarn add --dev @babel/core @babel/runtime @babel/preset-env
+yarn add --dev @babel/plugin-proposal-decorators @babel/plugin-transform-class-properties @babel/plugin-transform-runtime
+</code></pre>
+</li>
+<li>Configure <a href="https://babeljs.io/">Babel</a> by using <a href="https://babeljs.io/docs/babel-plugin-transform-class-properties">@babel/plugin-transform-class-properties</a> and
+<a href="https://babeljs.io/docs/babel-plugin-proposal-decorators">@babel/plugin-proposal-decorators</a> plugins. A possible <a href="https://babeljs.io/">Babel</a> configuration
+file <code>babelrc.json</code> is as follows:<pre class="prettyprint source lang-json"><code>{
+  &quot;presets&quot;: [
+    [&quot;@babel/preset-env&quot;, { &quot;modules&quot;: false }]
+  ],
+  &quot;plugins&quot;: [
+    &quot;@babel/plugin-transform-runtime&quot;,
+    [&quot;@babel/plugin-proposal-decorators&quot;, { &quot;version&quot;: &quot;2023-05&quot; }],
+    &quot;@babel/plugin-transform-class-properties&quot;
+  ]
+}
+</code></pre>
+<strong>Note:</strong> When bundling with <a href="https://vitejs.dev/">vite</a>, make sure to set the <code>modules</code> parameter
+of <code>@babel/preset-env</code> to <code>false</code>.</li>
+<li>Configure <a href="https://vitejs.dev/">vite</a> by modifying the <code>vite.config.js</code> file to add support for
+<a href="https://babeljs.io/">Babel</a>. A possible <code>vite.config.js</code> file is as follows:<pre class="prettyprint source lang-js"><code>import { fileURLToPath, URL } from 'node:url';
+import { defineConfig } from 'vite';
+import vue from '@vitejs/plugin-vue';
+import * as babel from '@babel/core';
+// A very simple Vite plugin support babel transpilation
+const babelPlugin = {
+  name: 'plugin-babel',
+  transform: (src, id) => {
+    if (/\.(jsx?|vue)$/.test(id)) {              // the pattern of the file to handle
+      return babel.transform(src, {
+        filename: id,
+        babelrc: true,
+      });
+    }
+  },
+};
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [
+    vue({
+      script: {
+        babelParserPlugins: ['decorators'],     // must enable decorators support
+      },
+    }),
+    babelPlugin,                                // must be after the vue plugin
+  ],
+  resolve: {
+    alias: {
+      '@': fileURLToPath(new URL('./src', import.meta.url)),
+    },
+  },
+});
+</code></pre>
+<strong>Note:</strong> In the above configuration file, we've implemented a simple <a href="https://vitejs.dev/">vite</a>
+plugin to transpile the code processed by the <a href="https://www.npmjs.com/package/@vitejs/plugin-vue">vite-plugin-vue</a> plugin using
+<a href="https://babeljs.io/">Babel</a>. Although there's a <a href="https://www.npmjs.com/package/vite-plugin-babel">vite-plugin-babel</a> plugin that claims to add
+<a href="https://babeljs.io/">Babel</a> support to <a href="https://vitejs.dev/">vite</a>, we found it doesn't correctly handle [vue] Single
+File Components (SFCs). After closely examining its source code, we
+determined that to achieve correct transpilation, we need to apply <a href="https://babeljs.io/">Babel</a>
+after <a href="https://www.npmjs.com/package/@vitejs/plugin-vue">vite-plugin-vue</a> processes the source code. Therefore, the very
+simple plugin function above suffices for our needs. As an alternative,
+you can use <a href="https://npmjs.com/package/@qubit-ltd/vite-plugin-babel">our version of vite-plugin-babel</a>, and the following is an
+example configuration:<pre class="prettyprint source lang-js"><code>import { fileURLToPath, URL } from 'node:url';
+import { defineConfig } from 'vite';
+import vue from '@vitejs/plugin-vue';
+import babel from '@qubit-ltd/vite-plugin-babel';
+export default defineConfig({
+  plugins: [
+    vue({
+      script: {
+        babelParserPlugins: ['decorators'],     // must enable decorators support
+      },
+    }),
+    babel(),
+  ],
+  resolve: {
+    alias: {
+      '@': fileURLToPath(new URL('./src', import.meta.url)),
+    },
+  },
+});
+</code></pre>
+</li>
+</ol>
+<h2><span id="contributing">Contributing</span></h2>
+<p>If you find any issues or have suggestions for improvements, please feel free
+to open an issue or submit a pull request to the <a href="https://github.com/Haixing-Hu/js-common-decorator">GitHub repository</a>.</p>
+<h2><span id="license">License</span></h2>
+<p><a href="https://npmjs.com/package/@qubit-ltd/common-decorator">@qubit-ltd/common-decorator</a> is distributed under the Apache 2.0 license.
+See the <a href="LICENSE">LICENSE</a> file for more details.</p></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>