@qubit-ltd/common-decorator 3.10.1 → 3.10.3

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 (78) hide show
  1. package/README.md +334 -0
  2. package/README.zh_CN.md +334 -0
  3. package/dist/common-decorator.cjs +136 -68
  4. package/dist/common-decorator.cjs.map +1 -1
  5. package/dist/common-decorator.min.cjs +1 -1
  6. package/dist/common-decorator.min.cjs.map +1 -1
  7. package/dist/common-decorator.min.mjs +1 -1
  8. package/dist/common-decorator.min.mjs.map +1 -1
  9. package/dist/common-decorator.mjs +133 -69
  10. package/dist/common-decorator.mjs.map +1 -1
  11. package/doc/api/DefaultAssignmentOptions.html +7 -638
  12. package/doc/api/DefaultOptions.html +6 -939
  13. package/doc/api/DefaultToJsonOptions.html +3 -633
  14. package/doc/api/Enum.html +9 -1742
  15. package/doc/api/Model.html +4 -3544
  16. package/doc/api/Page.html +3 -1105
  17. package/doc/api/data/search.json +1 -0
  18. package/doc/api/fonts/Inconsolata-Regular.ttf +0 -0
  19. package/doc/api/fonts/OpenSans-Regular.ttf +0 -0
  20. package/doc/api/fonts/WorkSans-Bold.ttf +0 -0
  21. package/doc/api/global.html +128 -6621
  22. package/doc/api/index.html +310 -1404
  23. package/doc/api/scripts/core.js +726 -0
  24. package/doc/api/scripts/core.min.js +23 -0
  25. package/doc/api/scripts/resize.js +90 -0
  26. package/doc/api/scripts/search.js +265 -0
  27. package/doc/api/scripts/search.min.js +6 -0
  28. package/doc/api/scripts/{prettify → third-party}/Apache-License-2.0.txt +202 -202
  29. package/doc/api/scripts/third-party/fuse.js +9 -0
  30. package/doc/api/scripts/third-party/hljs-line-num-original.js +369 -0
  31. package/doc/api/scripts/third-party/hljs-line-num.js +1 -0
  32. package/doc/api/scripts/third-party/hljs-original.js +5171 -0
  33. package/doc/api/scripts/third-party/hljs.js +1 -0
  34. package/doc/api/scripts/third-party/popper.js +5 -0
  35. package/doc/api/scripts/third-party/tippy.js +1 -0
  36. package/doc/api/scripts/third-party/tocbot.js +672 -0
  37. package/doc/api/scripts/third-party/tocbot.min.js +1 -0
  38. package/doc/api/styles/clean-jsdoc-theme-base.css +1159 -0
  39. package/doc/api/styles/clean-jsdoc-theme-dark.css +412 -0
  40. package/doc/api/styles/clean-jsdoc-theme-light.css +482 -0
  41. package/doc/api/styles/clean-jsdoc-theme-scrollbar.css +30 -0
  42. package/doc/api/styles/clean-jsdoc-theme-without-scrollbar.min.css +1 -0
  43. package/doc/api/styles/clean-jsdoc-theme.min.css +1 -0
  44. package/doc/common-decorator.min.visualization.html +1 -1
  45. package/doc/common-decorator.visualization.html +1 -1
  46. package/package.json +2 -1
  47. package/doc/api/fonts/OpenSans-Bold-webfont.eot +0 -0
  48. package/doc/api/fonts/OpenSans-Bold-webfont.svg +0 -1838
  49. package/doc/api/fonts/OpenSans-Bold-webfont.woff +0 -0
  50. package/doc/api/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
  51. package/doc/api/fonts/OpenSans-BoldItalic-webfont.svg +0 -1838
  52. package/doc/api/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
  53. package/doc/api/fonts/OpenSans-Italic-webfont.eot +0 -0
  54. package/doc/api/fonts/OpenSans-Italic-webfont.svg +0 -1838
  55. package/doc/api/fonts/OpenSans-Italic-webfont.woff +0 -0
  56. package/doc/api/fonts/OpenSans-Light-webfont.eot +0 -0
  57. package/doc/api/fonts/OpenSans-Light-webfont.svg +0 -1839
  58. package/doc/api/fonts/OpenSans-Light-webfont.woff +0 -0
  59. package/doc/api/fonts/OpenSans-LightItalic-webfont.eot +0 -0
  60. package/doc/api/fonts/OpenSans-LightItalic-webfont.svg +0 -1843
  61. package/doc/api/fonts/OpenSans-LightItalic-webfont.woff +0 -0
  62. package/doc/api/fonts/OpenSans-Regular-webfont.eot +0 -0
  63. package/doc/api/fonts/OpenSans-Regular-webfont.svg +0 -1839
  64. package/doc/api/fonts/OpenSans-Regular-webfont.woff +0 -0
  65. package/doc/api/fonts/OpenSans-Semibold-webfont.eot +0 -0
  66. package/doc/api/fonts/OpenSans-Semibold-webfont.svg +0 -1838
  67. package/doc/api/fonts/OpenSans-Semibold-webfont.ttf +0 -0
  68. package/doc/api/fonts/OpenSans-Semibold-webfont.woff +0 -0
  69. package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
  70. package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.svg +0 -1838
  71. package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
  72. package/doc/api/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
  73. package/doc/api/scripts/linenumber.js +0 -34
  74. package/doc/api/scripts/prettify/lang-css.js +0 -2
  75. package/doc/api/scripts/prettify/prettify.js +0 -28
  76. package/doc/api/styles/jsdoc-default.css +0 -699
  77. package/doc/api/styles/prettify-jsdoc.css +0 -120
  78. package/doc/api/styles/prettify-tomorrow.css +0 -141
package/doc/api/Page.html CHANGED
@@ -1,1105 +1,3 @@
1
- <!DOCTYPE html>
2
- <html lang="en">
3
- <head>
4
- <meta charset="utf-8">
5
- <meta name="viewport" content="width=device-width,initial-scale=1">
6
- <title>Page - Documentation</title>
7
-
8
- <script src="scripts/prettify/prettify.js"></script>
9
- <script src="scripts/prettify/lang-css.js"></script>
10
- <!--[if lt IE 9]>
11
- <script src="https://cdn.bootcdn.net/ajax/libs/html5shiv/3.7.3/html5shiv-printshiv.min.js"></script>
12
- <![endif]-->
13
- <link type="text/css" rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/ionicons/2.0.1/css/ionicons.min.css">
14
- <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
15
- <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
16
- </head>
17
- <body>
18
-
19
- <input type="checkbox" id="nav-trigger" class="nav-trigger" />
20
- <label for="nav-trigger" class="navicon-button x">
21
- <div class="navicon"></div>
22
- </label>
23
-
24
- <label for="nav-trigger" class="overlay"></label>
25
-
26
- <nav>
27
- <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#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#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#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#createDeferredReadonlyInitializer">createDeferredReadonlyInitializer</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#createImmediateReadonlyInitializer">createImmediateReadonlyInitializer</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#getDefaultInstance">getDefaultInstance</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#getFieldElementType">getFieldElementType</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#getFieldType">getFieldType</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#getSourceField">getSourceField</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>
28
- </nav>
29
-
30
- <div id="main">
31
-
32
- <h1 class="page-title">Page</h1>
33
-
34
-
35
-
36
-
37
-
38
-
39
-
40
- <section>
41
-
42
- <header>
43
-
44
- <h2>
45
- Page
46
- </h2>
47
-
48
- <div class="class-description"><p>The data page returned by the pagination list operation.</p></div>
49
-
50
-
51
- </header>
52
-
53
- <article>
54
- <div class="container-overview">
55
-
56
-
57
- <div class="section-method">
58
-
59
-
60
- <h2>Constructor</h2>
61
-
62
-
63
-
64
- <h4 class="name" id="Page"><span class="type-signature"></span>new Page<span class="signature">()</span><span class="type-signature"></span></h4>
65
-
66
-
67
-
68
-
69
-
70
-
71
-
72
-
73
-
74
-
75
- <dl class="details">
76
-
77
-
78
-
79
-
80
-
81
-
82
-
83
-
84
-
85
-
86
-
87
-
88
-
89
-
90
-
91
-
92
-
93
-
94
- <dt class="tag-author">Author:</dt>
95
- <dd class="tag-author">
96
- <ul>
97
- <li>Haixing Hu</li>
98
- </ul>
99
- </dd>
100
-
101
-
102
-
103
-
104
-
105
-
106
-
107
-
108
-
109
-
110
-
111
-
112
-
113
-
114
-
115
- </dl>
116
-
117
-
118
-
119
-
120
-
121
-
122
-
123
-
124
-
125
-
126
-
127
-
128
-
129
-
130
-
131
-
132
-
133
-
134
-
135
-
136
-
137
-
138
-
139
-
140
-
141
-
142
-
143
- </div>
144
-
145
- </div>
146
-
147
-
148
-
149
-
150
-
151
-
152
-
153
-
154
-
155
-
156
-
157
-
158
- <h3 class="subsection-title">Members</h3>
159
-
160
-
161
-
162
- <div class="section-members">
163
- <h4 class="name" id="content"><span class="type-signature"></span>content<span class="type-signature"> :Array</span></h4>
164
-
165
-
166
-
167
-
168
- <div class="description">
169
- <p>The content of the current page.</p>
170
- </div>
171
-
172
-
173
-
174
-
175
-
176
- <dl class="details">
177
-
178
-
179
-
180
-
181
-
182
-
183
-
184
-
185
-
186
-
187
-
188
-
189
-
190
-
191
-
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
-
201
-
202
-
203
-
204
-
205
-
206
-
207
-
208
-
209
- </dl>
210
-
211
-
212
-
213
- <h5>Type:</h5>
214
- <ul>
215
- <li>
216
-
217
- <span class="param-type"><code>Array</code></span>
218
-
219
-
220
- </li>
221
- </ul>
222
-
223
-
224
-
225
-
226
-
227
- </div>
228
-
229
-
230
-
231
- <div class="section-members">
232
- <h4 class="name" id="pageIndex"><span class="type-signature"></span>pageIndex<span class="type-signature"> :number</span></h4>
233
-
234
-
235
-
236
-
237
- <div class="description">
238
- <p>The index of the current page, starting from 0.</p>
239
- </div>
240
-
241
-
242
-
243
-
244
-
245
- <dl class="details">
246
-
247
-
248
-
249
-
250
-
251
-
252
-
253
-
254
-
255
-
256
-
257
-
258
-
259
-
260
-
261
-
262
-
263
-
264
-
265
-
266
-
267
-
268
-
269
-
270
-
271
-
272
-
273
-
274
-
275
-
276
-
277
-
278
- </dl>
279
-
280
-
281
-
282
- <h5>Type:</h5>
283
- <ul>
284
- <li>
285
-
286
- <span class="param-type"><code>number</code></span>
287
-
288
-
289
- </li>
290
- </ul>
291
-
292
-
293
-
294
-
295
-
296
- </div>
297
-
298
-
299
-
300
- <div class="section-members">
301
- <h4 class="name" id="pageSize"><span class="type-signature"></span>pageSize<span class="type-signature"> :number</span></h4>
302
-
303
-
304
-
305
-
306
- <div class="description">
307
- <p>The size of the current page, i.e., the number of records per page.</p>
308
- </div>
309
-
310
-
311
-
312
-
313
-
314
- <dl class="details">
315
-
316
-
317
-
318
-
319
-
320
-
321
-
322
-
323
-
324
-
325
-
326
-
327
-
328
-
329
-
330
-
331
-
332
-
333
-
334
-
335
-
336
-
337
-
338
-
339
-
340
-
341
-
342
-
343
-
344
-
345
-
346
-
347
- </dl>
348
-
349
-
350
-
351
- <h5>Type:</h5>
352
- <ul>
353
- <li>
354
-
355
- <span class="param-type"><code>number</code></span>
356
-
357
-
358
- </li>
359
- </ul>
360
-
361
-
362
-
363
-
364
-
365
- </div>
366
-
367
-
368
-
369
- <div class="section-members">
370
- <h4 class="name" id="totalCount"><span class="type-signature"></span>totalCount<span class="type-signature"> :number</span></h4>
371
-
372
-
373
-
374
-
375
- <div class="description">
376
- <p>The total number of records that meet the query conditions.</p>
377
- </div>
378
-
379
-
380
-
381
-
382
-
383
- <dl class="details">
384
-
385
-
386
-
387
-
388
-
389
-
390
-
391
-
392
-
393
-
394
-
395
-
396
-
397
-
398
-
399
-
400
-
401
-
402
-
403
-
404
-
405
-
406
-
407
-
408
-
409
-
410
-
411
-
412
-
413
-
414
-
415
-
416
- </dl>
417
-
418
-
419
-
420
- <h5>Type:</h5>
421
- <ul>
422
- <li>
423
-
424
- <span class="param-type"><code>number</code></span>
425
-
426
-
427
- </li>
428
- </ul>
429
-
430
-
431
-
432
-
433
-
434
- </div>
435
-
436
-
437
-
438
- <div class="section-members">
439
- <h4 class="name" id="totalPages"><span class="type-signature"></span>totalPages<span class="type-signature"> :number</span></h4>
440
-
441
-
442
-
443
-
444
- <div class="description">
445
- <p>The total number of pages.</p>
446
- </div>
447
-
448
-
449
-
450
-
451
-
452
- <dl class="details">
453
-
454
-
455
-
456
-
457
-
458
-
459
-
460
-
461
-
462
-
463
-
464
-
465
-
466
-
467
-
468
-
469
-
470
-
471
-
472
-
473
-
474
-
475
-
476
-
477
-
478
-
479
-
480
-
481
-
482
-
483
-
484
-
485
- </dl>
486
-
487
-
488
-
489
- <h5>Type:</h5>
490
- <ul>
491
- <li>
492
-
493
- <span class="param-type"><code>number</code></span>
494
-
495
-
496
- </li>
497
- </ul>
498
-
499
-
500
-
501
-
502
-
503
- </div>
504
-
505
-
506
-
507
-
508
-
509
- <h3 class="subsection-title">Methods</h3>
510
-
511
-
512
-
513
- <div class="section-method">
514
-
515
-
516
-
517
-
518
- <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>
519
-
520
-
521
-
522
-
523
-
524
-
525
- <div class="description">
526
- <p>Assigns the properties of another page to this page.</p>
527
- </div>
528
-
529
-
530
-
531
-
532
-
533
- <dl class="details">
534
-
535
-
536
-
537
-
538
-
539
-
540
-
541
-
542
-
543
-
544
-
545
-
546
-
547
-
548
-
549
-
550
-
551
-
552
-
553
-
554
-
555
-
556
-
557
-
558
-
559
-
560
-
561
-
562
-
563
-
564
- <dt class="tag-see">See:</dt>
565
- <dd class="tag-see">
566
- <ul>
567
- <li>DefaultOptions.get('assign')</li>
568
- </ul>
569
- </dd>
570
-
571
-
572
-
573
- </dl>
574
-
575
-
576
-
577
-
578
-
579
-
580
-
581
-
582
-
583
- <h5>Parameters:</h5>
584
-
585
-
586
- <table class="params">
587
- <thead>
588
- <tr>
589
-
590
- <th>Name</th>
591
-
592
-
593
- <th>Type</th>
594
-
595
-
596
-
597
-
598
-
599
- <th class="last">Description</th>
600
- </tr>
601
- </thead>
602
-
603
- <tbody>
604
-
605
-
606
- <tr>
607
-
608
- <td class="name"><code>obj</code></td>
609
-
610
-
611
- <td class="type">
612
-
613
-
614
- <span class="param-type"><code>object</code></span>
615
-
616
-
617
-
618
- </td>
619
-
620
-
621
-
622
-
623
-
624
- <td class="description last">
625
- <p>the data object, which may have a different prototype than this object.</p>
626
-
627
- </td>
628
- </tr>
629
-
630
-
631
-
632
- <tr>
633
-
634
- <td class="name"><code>options</code></td>
635
-
636
-
637
- <td class="type">
638
-
639
-
640
- <span class="param-type"><code>null</code></span>
641
- |
642
-
643
- <span class="param-type"><code>undefined</code></span>
644
- |
645
-
646
- <span class="param-type"><code>object</code></span>
647
-
648
-
649
-
650
- </td>
651
-
652
-
653
-
654
-
655
-
656
- <td class="description last">
657
- <p>the additional options for the assignment. If this argument is
658
- <code>undefined</code> or <code>null</code>, the default options will be used. The default
659
- options can be retrieved by calling <code>DefaultOptions.get('assign')</code>.
660
- Available options are:</p>
661
- <ul>
662
- <li><code>normalize: boolean</code>, indicates whether to normalize this object
663
- after the assignment. The default value is <code>true</code>.</li>
664
- <li><code>convertNaming: boolean</code>, indicates whether to convert the naming
665
- style of the target object. The default value is <code>false</code>.</li>
666
- <li><code>sourceNamingStyle: string</code>, the naming style of the source object,
667
- i.e., the first argument of the <code>assign()</code> method. The default value
668
- of this argument is <code>'LOWER_UNDERSCORE'</code>.</li>
669
- <li><code>targetNamingStyle: string</code>, the naming style of the target object,
670
- i.e., the object calling the <code>assign()</code> method. The default value
671
- of this argument is <code>'LOWER_CAMEL'</code>.</li>
672
- <li><code>types: object</code>, the additional information about types of
673
- fields of classes. The keys of this object are the path of the fields
674
- or sub-fields of the target object, the values are the type of the
675
- fields, represented as the constructor function of the type.
676
- The default value is <code>{}</code>.</li>
677
- <li><code>elementTypes: object</code>, the additional information about types of
678
- elements of fields of classes. The keys of this object are the path of
679
- the fields or sub-fields of the target object, the values are the type
680
- of the elements, represented as the constructor function of the type.
681
- The default value is <code>{}</code>.</li>
682
- </ul>
683
-
684
- </td>
685
- </tr>
686
-
687
-
688
- </tbody>
689
- </table>
690
-
691
-
692
-
693
-
694
-
695
-
696
-
697
-
698
-
699
-
700
-
701
-
702
-
703
-
704
-
705
-
706
- <div class="section-returns">
707
- <h5>Returns:</h5>
708
-
709
-
710
-
711
- <dl class="param-type">
712
- <dt>
713
- Type:
714
- </dt>
715
- <dd>
716
-
717
- <span class="param-type"><code>object</code></span>
718
-
719
-
720
- </dd>
721
- </dl>
722
-
723
-
724
- <div class="param-desc">
725
- <p>the reference to this object.</p>
726
- </div>
727
-
728
-
729
- </div>
730
-
731
-
732
-
733
-
734
-
735
- </div>
736
-
737
-
738
- <div class="section-method">
739
-
740
-
741
-
742
-
743
- <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>
744
-
745
-
746
-
747
-
748
-
749
-
750
- <div class="description">
751
- <p>Gets a page of data from an array.</p>
752
- </div>
753
-
754
-
755
-
756
-
757
-
758
- <dl class="details">
759
-
760
-
761
-
762
-
763
-
764
-
765
-
766
-
767
-
768
-
769
-
770
-
771
-
772
-
773
-
774
-
775
-
776
-
777
-
778
-
779
-
780
-
781
-
782
-
783
-
784
-
785
-
786
-
787
-
788
-
789
-
790
-
791
- </dl>
792
-
793
-
794
-
795
-
796
-
797
-
798
-
799
-
800
-
801
- <h5>Parameters:</h5>
802
-
803
-
804
- <table class="params">
805
- <thead>
806
- <tr>
807
-
808
- <th>Name</th>
809
-
810
-
811
- <th>Type</th>
812
-
813
-
814
-
815
-
816
-
817
- <th class="last">Description</th>
818
- </tr>
819
- </thead>
820
-
821
- <tbody>
822
-
823
-
824
- <tr>
825
-
826
- <td class="name"><code>pageRequest</code></td>
827
-
828
-
829
- <td class="type">
830
-
831
-
832
- <span class="param-type"><code>object</code></span>
833
-
834
-
835
-
836
- </td>
837
-
838
-
839
-
840
-
841
-
842
- <td class="description last">
843
- <p>the page request.</p>
844
-
845
- </td>
846
- </tr>
847
-
848
-
849
-
850
- <tr>
851
-
852
- <td class="name"><code>array</code></td>
853
-
854
-
855
- <td class="type">
856
-
857
-
858
- <span class="param-type"><code>Array</code></span>
859
-
860
-
861
-
862
- </td>
863
-
864
-
865
-
866
-
867
-
868
- <td class="description last">
869
- <p>the array of data.</p>
870
-
871
- </td>
872
- </tr>
873
-
874
-
875
- </tbody>
876
- </table>
877
-
878
-
879
-
880
-
881
-
882
-
883
-
884
-
885
-
886
-
887
-
888
-
889
-
890
-
891
-
892
-
893
- <div class="section-returns">
894
- <h5>Returns:</h5>
895
-
896
-
897
-
898
- <dl class="param-type">
899
- <dt>
900
- Type:
901
- </dt>
902
- <dd>
903
-
904
- <span class="param-type"><code><a href="Page.html">Page</a></code></span>
905
-
906
-
907
- </dd>
908
- </dl>
909
-
910
-
911
- <div class="param-desc">
912
- <p>the specified page of data from the array.</p>
913
- </div>
914
-
915
-
916
- </div>
917
-
918
-
919
-
920
-
921
-
922
- </div>
923
-
924
-
925
- <div class="section-method">
926
-
927
-
928
-
929
-
930
- <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>
931
-
932
-
933
-
934
-
935
-
936
-
937
- <div class="description">
938
- <p>Creates a empty page with the specified page size.</p>
939
- </div>
940
-
941
-
942
-
943
-
944
-
945
- <dl class="details">
946
-
947
-
948
-
949
-
950
-
951
-
952
-
953
-
954
-
955
-
956
-
957
-
958
-
959
-
960
-
961
-
962
-
963
-
964
-
965
-
966
-
967
-
968
-
969
-
970
-
971
-
972
-
973
-
974
-
975
-
976
-
977
-
978
- </dl>
979
-
980
-
981
-
982
-
983
-
984
-
985
-
986
-
987
-
988
- <h5>Parameters:</h5>
989
-
990
-
991
- <table class="params">
992
- <thead>
993
- <tr>
994
-
995
- <th>Name</th>
996
-
997
-
998
- <th>Type</th>
999
-
1000
-
1001
-
1002
-
1003
-
1004
- <th class="last">Description</th>
1005
- </tr>
1006
- </thead>
1007
-
1008
- <tbody>
1009
-
1010
-
1011
- <tr>
1012
-
1013
- <td class="name"><code>pageSize</code></td>
1014
-
1015
-
1016
- <td class="type">
1017
-
1018
- </td>
1019
-
1020
-
1021
-
1022
-
1023
-
1024
- <td class="description last">
1025
- <p>the size of the page.</p>
1026
-
1027
- </td>
1028
- </tr>
1029
-
1030
-
1031
- </tbody>
1032
- </table>
1033
-
1034
-
1035
-
1036
-
1037
-
1038
-
1039
-
1040
-
1041
-
1042
-
1043
-
1044
-
1045
-
1046
-
1047
-
1048
-
1049
- <div class="section-returns">
1050
- <h5>Returns:</h5>
1051
-
1052
-
1053
-
1054
- <dl class="param-type">
1055
- <dt>
1056
- Type:
1057
- </dt>
1058
- <dd>
1059
-
1060
- <span class="param-type"><code><a href="Page.html">Page</a></code></span>
1061
-
1062
-
1063
- </dd>
1064
- </dl>
1065
-
1066
-
1067
- <div class="param-desc">
1068
- <p>the created empty page.</p>
1069
- </div>
1070
-
1071
-
1072
- </div>
1073
-
1074
-
1075
-
1076
-
1077
-
1078
- </div>
1079
-
1080
-
1081
-
1082
-
1083
-
1084
-
1085
- </article>
1086
-
1087
- </section>
1088
-
1089
-
1090
-
1091
-
1092
- </div>
1093
-
1094
- <br class="clear">
1095
-
1096
- <footer>
1097
- Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.4</a>
1098
- on Mon May 05 2025 17:29:02 GMT+0800 (China Standard Time)
1099
- using the <a href="https://github.com/Haixing-Hu/jsdoc-minami">customized Minami theme</a>.
1100
- </footer>
1101
-
1102
- <script>prettyPrint();</script>
1103
- <script src="scripts/linenumber.js"></script>
1104
- </body>
1105
- </html>
1
+ <!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Class: Page</title><!--[if lt IE 9]>
2
+ <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
3
+ <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124 C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124 c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227 c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6 V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474 c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323 c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848 S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328 c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="DefaultAssignmentOptions.html">DefaultAssignmentOptions</a></div><div class="sidebar-section-children"><a href="DefaultOptions.html">DefaultOptions</a></div><div class="sidebar-section-children"><a href="DefaultToJsonOptions.html">DefaultToJsonOptions</a></div><div class="sidebar-section-children"><a href="Page.html">Page</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-namespaces"><div>Namespaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Enum.html">Enum</a></div><div class="sidebar-section-children"><a href="Model.html">Model</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#ElementType">ElementType</a></div><div class="sidebar-section-children"><a href="global.html#Label">Label</a></div><div class="sidebar-section-children"><a href="global.html#NameField">NameField</a></div><div class="sidebar-section-children"><a href="global.html#NonEmpty">NonEmpty</a></div><div class="sidebar-section-children"><a href="global.html#Normalizable">Normalizable</a></div><div class="sidebar-section-children"><a href="global.html#Nullable">Nullable</a></div><div class="sidebar-section-children"><a href="global.html#Readonly">Readonly</a></div><div class="sidebar-section-children"><a href="global.html#Timeout">Timeout</a></div><div class="sidebar-section-children"><a href="global.html#Type">Type</a></div><div class="sidebar-section-children"><a href="global.html#Validatable">Validatable</a></div><div class="sidebar-section-children"><a href="global.html#assign">assign</a></div><div class="sidebar-section-children"><a href="global.html#create">create</a></div><div class="sidebar-section-children"><a href="global.html#createArray">createArray</a></div><div class="sidebar-section-children"><a href="global.html#createDeferredReadonlyInitializer">createDeferredReadonlyInitializer</a></div><div class="sidebar-section-children"><a href="global.html#createImmediateReadonlyInitializer">createImmediateReadonlyInitializer</a></div><div class="sidebar-section-children"><a href="global.html#createPage">createPage</a></div><div class="sidebar-section-children"><a href="global.html#defaultNormalizer">defaultNormalizer</a></div><div class="sidebar-section-children"><a href="global.html#defaultValidator">defaultValidator</a></div><div class="sidebar-section-children"><a href="global.html#enumNormalizer">enumNormalizer</a></div><div class="sidebar-section-children"><a href="global.html#getDefaultInstance">getDefaultInstance</a></div><div class="sidebar-section-children"><a href="global.html#getFieldElementType">getFieldElementType</a></div><div class="sidebar-section-children"><a href="global.html#getFieldType">getFieldType</a></div><div class="sidebar-section-children"><a href="global.html#getSourceField">getSourceField</a></div><div class="sidebar-section-children"><a href="global.html#hasOwnProperty">hasOwnProperty</a></div><div class="sidebar-section-children"><a href="global.html#hasProperty">hasProperty</a></div><div class="sidebar-section-children"><a href="global.html#hasPrototypeFunction">hasPrototypeFunction</a></div><div class="sidebar-section-children"><a href="global.html#isEnumClass">isEnumClass</a></div><div class="sidebar-section-children"><a href="global.html#isEnumerator">isEnumerator</a></div><div class="sidebar-section-children"><a href="global.html#isValidPageSource">isValidPageSource</a></div><div class="sidebar-section-children"><a href="global.html#normalize">normalize</a></div><div class="sidebar-section-children"><a href="global.html#stringifyId">stringifyId</a></div><div class="sidebar-section-children"><a href="global.html#toJSON">toJSON</a></div><div class="sidebar-section-children"><a href="global.html#toJsonString">toJsonString</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="Page-title" class="has-anchor">Page</h1><div class="class-description"><p>The data page returned by the pagination list operation.</p></div></header><article><div class="container-overview"><h2 id="constructor" class="has-anchor">Constructor</h2><h3 class="name has-anchor" id="Page"><span class="type-signature"></span>new Page<span class="signature">()</span></h3><dl class="details"><div class="details-item-container"><dt class="tag-author bold">Author</dt><dd class="tag-author"><ul><li>Haixing Hu</li></ul></dd></div></dl></div><h2 id="members" class="subsection-title has-anchor">Members</h2><h3 class="name has-anchor" id="content"><span class="type-signature"></span>content<span class="type-signature"> :Array</span></h3><div class="description"><p>The content of the current page.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array</span></li></ul></div><h3 class="name has-anchor" id="pageIndex"><span class="type-signature"></span>pageIndex<span class="type-signature"> :number</span></h3><div class="description"><p>The index of the current page, starting from 0.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">number</span></li></ul></div><h3 class="name has-anchor" id="pageSize"><span class="type-signature"></span>pageSize<span class="type-signature"> :number</span></h3><div class="description"><p>The size of the current page, i.e., the number of records per page.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">number</span></li></ul></div><h3 class="name has-anchor" id="totalCount"><span class="type-signature"></span>totalCount<span class="type-signature"> :number</span></h3><div class="description"><p>The total number of records that meet the query conditions.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">number</span></li></ul></div><h3 class="name has-anchor" id="totalPages"><span class="type-signature"></span>totalPages<span class="type-signature"> :number</span></h3><div class="description"><p>The total number of pages.</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">number</span></li></ul></div><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="assign"><span class="type-signature"></span>assign<span class="signature">(obj, options)</span><span class="type-signature"> &rarr; {object}</span></h3><div class="description"><p>Assigns the properties of another page to this page.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>obj</code></td><td class="type"><span class="param-type">object</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">null</span> |<wbr> <span class="param-type">undefined</span> |<wbr> <span class="param-type">object</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><dl class="details"><div class="details-item-container"><dt class="tag-see bold">See</dt><dd class="tag-see"><ul><li>DefaultOptions.get('assign')</li></ul></dd></div></dl><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>the reference to this object.</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type">object</span></dd></dl></div><h3 class="name has-anchor" 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></h3><div class="description"><p>Gets a page of data from an array.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>pageRequest</code></td><td class="type"><span class="param-type">object</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">Array</span></td><td class="description last"><p>the array of data.</p></td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>the specified page of data from the array.</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type"><a href="Page.html">Page</a></span></dd></dl></div><h3 class="name has-anchor" 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></h3><div class="description"><p>Creates a empty page with the specified page size.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>pageSize</code></td><td class="type"></td><td class="description last"><p>the size of the page.</p></td></tr></tbody></table></div><div class="method-member-container mt-20"><strong>Returns:</strong><div class="param-desc"><p>the created empty page.</p></div><dl class="param-type"><dt>Type:&nbsp;</dt><dd><span class="param-type"><a href="Page.html">Page</a></span></dd></dl></div></article></section></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><div class="mobile-nav-links"></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-classes"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="DefaultAssignmentOptions.html">DefaultAssignmentOptions</a></div><div class="sidebar-section-children"><a href="DefaultOptions.html">DefaultOptions</a></div><div class="sidebar-section-children"><a href="DefaultToJsonOptions.html">DefaultToJsonOptions</a></div><div class="sidebar-section-children"><a href="Page.html">Page</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-namespaces"><div>Namespaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Enum.html">Enum</a></div><div class="sidebar-section-children"><a href="Model.html">Model</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="sidebar-global"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#ElementType">ElementType</a></div><div class="sidebar-section-children"><a href="global.html#Label">Label</a></div><div class="sidebar-section-children"><a href="global.html#NameField">NameField</a></div><div class="sidebar-section-children"><a href="global.html#NonEmpty">NonEmpty</a></div><div class="sidebar-section-children"><a href="global.html#Normalizable">Normalizable</a></div><div class="sidebar-section-children"><a href="global.html#Nullable">Nullable</a></div><div class="sidebar-section-children"><a href="global.html#Readonly">Readonly</a></div><div class="sidebar-section-children"><a href="global.html#Timeout">Timeout</a></div><div class="sidebar-section-children"><a href="global.html#Type">Type</a></div><div class="sidebar-section-children"><a href="global.html#Validatable">Validatable</a></div><div class="sidebar-section-children"><a href="global.html#assign">assign</a></div><div class="sidebar-section-children"><a href="global.html#create">create</a></div><div class="sidebar-section-children"><a href="global.html#createArray">createArray</a></div><div class="sidebar-section-children"><a href="global.html#createDeferredReadonlyInitializer">createDeferredReadonlyInitializer</a></div><div class="sidebar-section-children"><a href="global.html#createImmediateReadonlyInitializer">createImmediateReadonlyInitializer</a></div><div class="sidebar-section-children"><a href="global.html#createPage">createPage</a></div><div class="sidebar-section-children"><a href="global.html#defaultNormalizer">defaultNormalizer</a></div><div class="sidebar-section-children"><a href="global.html#defaultValidator">defaultValidator</a></div><div class="sidebar-section-children"><a href="global.html#enumNormalizer">enumNormalizer</a></div><div class="sidebar-section-children"><a href="global.html#getDefaultInstance">getDefaultInstance</a></div><div class="sidebar-section-children"><a href="global.html#getFieldElementType">getFieldElementType</a></div><div class="sidebar-section-children"><a href="global.html#getFieldType">getFieldType</a></div><div class="sidebar-section-children"><a href="global.html#getSourceField">getSourceField</a></div><div class="sidebar-section-children"><a href="global.html#hasOwnProperty">hasOwnProperty</a></div><div class="sidebar-section-children"><a href="global.html#hasProperty">hasProperty</a></div><div class="sidebar-section-children"><a href="global.html#hasPrototypeFunction">hasPrototypeFunction</a></div><div class="sidebar-section-children"><a href="global.html#isEnumClass">isEnumClass</a></div><div class="sidebar-section-children"><a href="global.html#isEnumerator">isEnumerator</a></div><div class="sidebar-section-children"><a href="global.html#isValidPageSource">isValidPageSource</a></div><div class="sidebar-section-children"><a href="global.html#normalize">normalize</a></div><div class="sidebar-section-children"><a href="global.html#stringifyId">stringifyId</a></div><div class="sidebar-section-children"><a href="global.html#toJSON">toJSON</a></div><div class="sidebar-section-children"><a href="global.html#toJsonString">toJsonString</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>