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

@@ -0,0 +1,1105 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Page - Documentation</title>
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="https://cdn.bootcdn.net/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/ionicons/2.0.1/css/ionicons.min.css">
+    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
+</head>
+<body>
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+<label for="nav-trigger" class="overlay"></label>
+<nav>
+    <li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="DefaultAssignmentOptions.html">DefaultAssignmentOptions</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="DefaultOptions.html">DefaultOptions</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="DefaultOptions.html#.get">get</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="DefaultOptions.html#.merge">merge</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="DefaultOptions.html#.reset">reset</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="DefaultOptions.html#.set">set</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="DefaultToJsonOptions.html">DefaultToJsonOptions</a></span></li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Page.html">Page</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Page.html#assign">assign</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Page.html#.getFrom">getFrom</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Page.html#.newEmpty">newEmpty</a></span></li><li class="nav-heading">Namespaces</li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="Enum.html">Enum</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.has">Class.has</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.hasCode">Class.hasCode</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.hasName">Class.hasName</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.hasValue">Class.hasValue</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.of">Class.of</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.ofCode">Class.ofCode</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.ofName">Class.ofName</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.ofValue">Class.ofValue</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Enum.html#.Class.values">Class.values</a></span></li><li class="nav-heading"><span class="nav-item-type type-namespace">N</span><span class="nav-item-name"><a href="Model.html">Model</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#assign">assign</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#clear">clear</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#clone">clone</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#equals">equals</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#generateId">generateId</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#isEmpty">isEmpty</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#normalize">normalize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#normalizeField">normalizeField</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#toJSON">toJSON</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#toJsonString">toJsonString</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#validate">validate</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#validateField">validateField</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#.Class.create">Class.create</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#.Class.createArray">Class.createArray</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#.Class.createPage">Class.createPage</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#.Class.isNullishOrEmpty">Class.isNullishOrEmpty</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Model.html#.Class.parseJsonString">Class.parseJsonString</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#ElementType">ElementType</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Enumerable">Enumerable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Label">Label</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#NameField">NameField</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#NonEmpty">NonEmpty</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#NonEnumerable">NonEnumerable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Normalizable">Normalizable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Nullable">Nullable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Payload">Payload</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Readonly">Readonly</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Timeout">Timeout</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Type">Type</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#Validatable">Validatable</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#assign">assign</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#create">create</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#createArray">createArray</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#createPage">createPage</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#defaultNormalizer">defaultNormalizer</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#defaultValidator">defaultValidator</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#enumNormalizer">enumNormalizer</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isEnumClass">isEnumClass</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isEnumerator">isEnumerator</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#isValidPageSource">isValidPageSource</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#normalize">normalize</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#stringifyId">stringifyId</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#toJSON">toJSON</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#toJsonString">toJsonString</a></span></li>
+</nav>
+<div id="main">
+    <h1 class="page-title">Page</h1>
+<section>
+<header>
+        <h2>
+        Page
+        </h2>
+            <div class="class-description"><p>The data page returned by the pagination list operation.</p></div>
+</header>
+<article>
+    <div class="container-overview">
+<div class="section-method">
+    <h2>Constructor</h2>
+    <h4 class="name" id="Page"><span class="type-signature"></span>new Page<span class="signature">()</span><span class="type-signature"></span></h4>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li>Haixing Hu</li>
+        </ul>
+    </dd>
+</dl>
+</div>
+    </div>
+        <h3 class="subsection-title">Members</h3>
+<div class="section-members">
+<h4 class="name" id="content"><span class="type-signature"></span>content<span class="type-signature"> :Array</span></h4>
+<div class="description">
+    <p>The content of the current page.</p>
+</div>
+<dl class="details">
+</dl>
+    <h5>Type:</h5>
+    <ul>
+        <li>
+<span class="param-type"><code>Array</code></span>
+        </li>
+    </ul>
+</div>
+<div class="section-members">
+<h4 class="name" id="pageIndex"><span class="type-signature"></span>pageIndex<span class="type-signature"> :number</span></h4>
+<div class="description">
+    <p>The index of the current page, starting from 0.</p>
+</div>
+<dl class="details">
+</dl>
+    <h5>Type:</h5>
+    <ul>
+        <li>
+<span class="param-type"><code>number</code></span>
+        </li>
+    </ul>
+</div>
+<div class="section-members">
+<h4 class="name" id="pageSize"><span class="type-signature"></span>pageSize<span class="type-signature"> :number</span></h4>
+<div class="description">
+    <p>The size of the current page, i.e., the number of records per page.</p>
+</div>
+<dl class="details">
+</dl>
+    <h5>Type:</h5>
+    <ul>
+        <li>
+<span class="param-type"><code>number</code></span>
+        </li>
+    </ul>
+</div>
+<div class="section-members">
+<h4 class="name" id="totalCount"><span class="type-signature"></span>totalCount<span class="type-signature"> :number</span></h4>
+<div class="description">
+    <p>The total number of records that meet the query conditions.</p>
+</div>
+<dl class="details">
+</dl>
+    <h5>Type:</h5>
+    <ul>
+        <li>
+<span class="param-type"><code>number</code></span>
+        </li>
+    </ul>
+</div>
+<div class="section-members">
+<h4 class="name" id="totalPages"><span class="type-signature"></span>totalPages<span class="type-signature"> :number</span></h4>
+<div class="description">
+    <p>The total number of pages.</p>
+</div>
+<dl class="details">
+</dl>
+    <h5>Type:</h5>
+    <ul>
+        <li>
+<span class="param-type"><code>number</code></span>
+        </li>
+    </ul>
+</div>
+        <h3 class="subsection-title">Methods</h3>
+<div class="section-method">
+    <h4 class="name" id="assign"><span class="type-signature"></span>assign<span class="signature">(obj, options)</span><span class="type-signature"> &rarr; {object}</span></h4>
+<div class="description">
+    <p>Assigns the properties of another page to this page.</p>
+</div>
+<dl class="details">
+    <dt class="tag-see">See:</dt>
+    <dd class="tag-see">
+        <ul>
+            <li>DefaultOptions.get('assign')</li>
+        </ul>
+    </dd>
+</dl>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>obj</code></td>
+            <td class="type">
+<span class="param-type"><code>object</code></span>
+            </td>
+            <td class="description last">
+                <p>the data object, which may have a different prototype than this object.</p>
+            </td>
+        </tr>
+        <tr>
+                <td class="name"><code>options</code></td>
+            <td class="type">
+<span class="param-type"><code>null</code></span>
+|
+<span class="param-type"><code>undefined</code></span>
+|
+<span class="param-type"><code>object</code></span>
+            </td>
+            <td class="description last">
+                <p>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:</p>
+<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>
+            </td>
+        </tr>
+    </tbody>
+</table>
+<div class="section-returns">
+<h5>Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type:
+    </dt>
+    <dd>
+<span class="param-type"><code>object</code></span>
+    </dd>
+</dl>
+<div class="param-desc">
+    <p>the reference to this object.</p>
+</div>
+</div>
+</div>
+<div class="section-method">
+    <h4 class="name" id=".getFrom"><span class="type-signature">(static) </span>getFrom<span class="signature">(pageRequest, array)</span><span class="type-signature"> &rarr; {<a href="Page.html">Page</a>}</span></h4>
+<div class="description">
+    <p>Gets a page of data from an array.</p>
+</div>
+<dl class="details">
+</dl>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>pageRequest</code></td>
+            <td class="type">
+<span class="param-type"><code>object</code></span>
+            </td>
+            <td class="description last">
+                <p>the page request.</p>
+            </td>
+        </tr>
+        <tr>
+                <td class="name"><code>array</code></td>
+            <td class="type">
+<span class="param-type"><code>Array</code></span>
+            </td>
+            <td class="description last">
+                <p>the array of data.</p>
+            </td>
+        </tr>
+    </tbody>
+</table>
+<div class="section-returns">
+<h5>Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type:
+    </dt>
+    <dd>
+<span class="param-type"><code><a href="Page.html">Page</a></code></span>
+    </dd>
+</dl>
+<div class="param-desc">
+    <p>the specified page of data from the array.</p>
+</div>
+</div>
+</div>
+<div class="section-method">
+    <h4 class="name" id=".newEmpty"><span class="type-signature">(static) </span>newEmpty<span class="signature">(pageSize)</span><span class="type-signature"> &rarr; {<a href="Page.html">Page</a>}</span></h4>
+<div class="description">
+    <p>Creates a empty page with the specified page size.</p>
+</div>
+<dl class="details">
+</dl>
+    <h5>Parameters:</h5>
+<table class="params">
+    <thead>
+    <tr>
+        <th>Name</th>
+        <th>Type</th>
+        <th class="last">Description</th>
+    </tr>
+    </thead>
+    <tbody>
+        <tr>
+                <td class="name"><code>pageSize</code></td>
+            <td class="type">
+            </td>
+            <td class="description last">
+                <p>the size of the page.</p>
+            </td>
+        </tr>
+    </tbody>
+</table>
+<div class="section-returns">
+<h5>Returns:</h5>
+<dl class="param-type">
+    <dt>
+        Type:
+    </dt>
+    <dd>
+<span class="param-type"><code><a href="Page.html">Page</a></code></span>
+    </dd>
+</dl>
+<div class="param-desc">
+    <p>the created empty page.</p>
+</div>
+</div>
+</div>
+</article>
+</section>
+</div>
+<br class="clear">
+<footer>
+    Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
+     on Mon Jan 06 2025 12:25:48 GMT+0800 (China Standard Time)
+    using the <a href="https://github.com/Haixing-Hu/jsdoc-minami">customized Minami theme</a>.
+</footer>
+<script>prettyPrint();</script>
+<script src="scripts/linenumber.js"></script>
+</body>
+</html>