@loopback/metadata 4.0.0-alpha.8 → 4.1.0

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 (97) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +273 -150
  3. package/dist/decorator-factory.d.ts +297 -0
  4. package/{dist6/src → dist}/decorator-factory.js +197 -90
  5. package/dist/decorator-factory.js.map +1 -0
  6. package/dist/index.d.ts +22 -1
  7. package/dist/index.js +24 -7
  8. package/dist/index.js.map +1 -0
  9. package/dist/inspector.d.ts +120 -0
  10. package/dist/inspector.js +186 -0
  11. package/dist/inspector.js.map +1 -0
  12. package/dist/{src/reflect.d.ts → reflect.d.ts} +16 -15
  13. package/dist/{src/reflect.js → reflect.js} +7 -8
  14. package/dist/reflect.js.map +1 -0
  15. package/dist/types.d.ts +70 -0
  16. package/dist/types.js +32 -0
  17. package/dist/types.js.map +1 -0
  18. package/package.json +43 -44
  19. package/src/decorator-factory.ts +289 -140
  20. package/src/index.ts +22 -2
  21. package/src/inspector.ts +118 -126
  22. package/src/reflect.ts +32 -21
  23. package/src/types.ts +94 -0
  24. package/CHANGELOG.md +0 -91
  25. package/api-docs/apple-touch-icon-114x114-precomposed.png +0 -0
  26. package/api-docs/apple-touch-icon-144x144-precomposed.png +0 -0
  27. package/api-docs/apple-touch-icon-57x57-precomposed.png +0 -0
  28. package/api-docs/apple-touch-icon-72x72-precomposed.png +0 -0
  29. package/api-docs/apple-touch-icon-precomposed.png +0 -0
  30. package/api-docs/apple-touch-icon.png +0 -0
  31. package/api-docs/css/bootstrap.min.css +0 -9
  32. package/api-docs/css/code-themes/arta.css +0 -158
  33. package/api-docs/css/code-themes/ascetic.css +0 -50
  34. package/api-docs/css/code-themes/brown_paper.css +0 -104
  35. package/api-docs/css/code-themes/brown_papersq.png +0 -0
  36. package/api-docs/css/code-themes/dark.css +0 -103
  37. package/api-docs/css/code-themes/default.css +0 -135
  38. package/api-docs/css/code-themes/far.css +0 -111
  39. package/api-docs/css/code-themes/github.css +0 -127
  40. package/api-docs/css/code-themes/googlecode.css +0 -144
  41. package/api-docs/css/code-themes/idea.css +0 -121
  42. package/api-docs/css/code-themes/ir_black.css +0 -104
  43. package/api-docs/css/code-themes/magula.css +0 -121
  44. package/api-docs/css/code-themes/monokai.css +0 -114
  45. package/api-docs/css/code-themes/pojoaque.css +0 -104
  46. package/api-docs/css/code-themes/pojoaque.jpg +0 -0
  47. package/api-docs/css/code-themes/rainbow.css +0 -114
  48. package/api-docs/css/code-themes/school_book.css +0 -111
  49. package/api-docs/css/code-themes/school_book.png +0 -0
  50. package/api-docs/css/code-themes/sl-theme.css +0 -45
  51. package/api-docs/css/code-themes/solarized_dark.css +0 -88
  52. package/api-docs/css/code-themes/solarized_light.css +0 -88
  53. package/api-docs/css/code-themes/sunburst.css +0 -158
  54. package/api-docs/css/code-themes/tomorrow-night-blue.css +0 -52
  55. package/api-docs/css/code-themes/tomorrow-night-bright.css +0 -51
  56. package/api-docs/css/code-themes/tomorrow-night-eighties.css +0 -51
  57. package/api-docs/css/code-themes/tomorrow-night.css +0 -52
  58. package/api-docs/css/code-themes/tomorrow.css +0 -49
  59. package/api-docs/css/code-themes/vs.css +0 -86
  60. package/api-docs/css/code-themes/xcode.css +0 -154
  61. package/api-docs/css/code-themes/zenburn.css +0 -115
  62. package/api-docs/css/main.css +0 -139
  63. package/api-docs/favicon.ico +0 -0
  64. package/api-docs/fonts/0ihfXUL2emPh0ROJezvraLO3LdcAZYWl9Si6vvxL-qU.woff +0 -0
  65. package/api-docs/fonts/OsJ2DjdpjqFRVUSto6IffLO3LdcAZYWl9Si6vvxL-qU.woff +0 -0
  66. package/api-docs/fonts/_aijTyevf54tkVDLy-dlnLO3LdcAZYWl9Si6vvxL-qU.woff +0 -0
  67. package/api-docs/index.html +0 -4735
  68. package/api-docs/js/main.js +0 -19
  69. package/api-docs/js/vendor/bootstrap.min.js +0 -6
  70. package/api-docs/js/vendor/jquery-1.10.1.min.js +0 -6
  71. package/api-docs/js/vendor/jquery.scrollTo-1.4.3.1.js +0 -218
  72. package/api-docs/js/vendor/modernizr-2.6.2-respond-1.1.0.min.js +0 -11
  73. package/dist/src/decorator-factory.d.ts +0 -252
  74. package/dist/src/decorator-factory.js +0 -468
  75. package/dist/src/decorator-factory.js.map +0 -1
  76. package/dist/src/index.d.ts +0 -3
  77. package/dist/src/index.js +0 -13
  78. package/dist/src/index.js.map +0 -1
  79. package/dist/src/inspector.d.ts +0 -150
  80. package/dist/src/inspector.js +0 -163
  81. package/dist/src/inspector.js.map +0 -1
  82. package/dist/src/reflect.js.map +0 -1
  83. package/dist6/index.d.ts +0 -1
  84. package/dist6/index.js +0 -13
  85. package/dist6/src/decorator-factory.d.ts +0 -252
  86. package/dist6/src/decorator-factory.js.map +0 -1
  87. package/dist6/src/index.d.ts +0 -3
  88. package/dist6/src/index.js +0 -13
  89. package/dist6/src/index.js.map +0 -1
  90. package/dist6/src/inspector.d.ts +0 -150
  91. package/dist6/src/inspector.js +0 -163
  92. package/dist6/src/inspector.js.map +0 -1
  93. package/dist6/src/reflect.d.ts +0 -38
  94. package/dist6/src/reflect.js +0 -143
  95. package/dist6/src/reflect.js.map +0 -1
  96. package/index.d.ts +0 -6
  97. package/index.js +0 -7
@@ -1,4735 +0,0 @@
1
- <!DOCTYPE html>
2
- <!--[if lt IE 7]> <html class="no-js lt-ie9 lt-ie8 lt-ie7"> <![endif]-->
3
- <!--[if IE 7]> <html class="no-js lt-ie9 lt-ie8"> <![endif]-->
4
- <!--[if IE 8]> <html class="no-js lt-ie9"> <![endif]-->
5
- <!--[if gt IE 8]><!--> <html class="no-js"> <!--<![endif]-->
6
- <head>
7
- <meta charset="utf-8">
8
- <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
9
- <title></title>
10
- <meta name="description" content="">
11
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
12
-
13
- <link rel="stylesheet" href="css/bootstrap.min.css">
14
- <link rel="stylesheet" href="css/code-themes/sl-theme.css">
15
- <link rel="stylesheet" href="css/main.css">
16
- </head>
17
- <body>
18
- <div class="navbar navbar-inverse navbar-static-top" role="navigation">
19
- <div class="navbar-header">
20
- <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
21
- <span class="icon-bar"></span>
22
- <span class="icon-bar"></span>
23
- <span class="icon-bar"></span>
24
- </button>
25
- <a class="navbar-brand" href="/">docs.strongloop.com</a>
26
- </div>
27
- <div id="modules"></div>
28
- </div>
29
-
30
- <div class="row">
31
- <div class="col-lg-3 column scroll-spy-target">
32
- <ul class="nav nav-pills nav-stacked">
33
- <div id="versions"></div>
34
-
35
- <li class="depth-3">
36
- <a href="#ClassDecoratorFactory">Class: ClassDecoratorFactory</a>
37
- </li>
38
-
39
- <li class="depth-4">
40
- <a href="#153006">create</a>
41
- </li>
42
-
43
- <li class="depth-4">
44
- <a href="#153008">createDecorator</a>
45
- </li>
46
-
47
- <li class="depth-3">
48
- <a href="#DecoratorFactory">Class: DecoratorFactory</a>
49
- </li>
50
-
51
- <li class="depth-4">
52
- <a href="#152932">constructor</a>
53
- </li>
54
-
55
- <li class="depth-4">
56
- <a href="#152973">create</a>
57
- </li>
58
-
59
- <li class="depth-4">
60
- <a href="#152958">getTarget</a>
61
- </li>
62
-
63
- <li class="depth-4">
64
- <a href="#152954">withTarget</a>
65
- </li>
66
-
67
- <li class="depth-4">
68
- <a href="#152988">cloneDeep</a>
69
- </li>
70
-
71
- <li class="depth-4">
72
- <a href="#152950">getNumberOfParameters</a>
73
- </li>
74
-
75
- <li class="depth-4">
76
- <a href="#152945">getTargetName</a>
77
- </li>
78
-
79
- <li class="depth-3">
80
- <a href="#MethodDecoratorFactory">Class: MethodDecoratorFactory</a>
81
- </li>
82
-
83
- <li class="depth-4">
84
- <a href="#153152">create</a>
85
- </li>
86
-
87
- <li class="depth-4">
88
- <a href="#153154">createDecorator</a>
89
- </li>
90
-
91
- <li class="depth-3">
92
- <a href="#MethodParameterDecoratorFactory">Class: MethodParameterDecoratorFactory</a>
93
- </li>
94
-
95
- <li class="depth-4">
96
- <a href="#153311">create</a>
97
- </li>
98
-
99
- <li class="depth-4">
100
- <a href="#153313">createDecorator</a>
101
- </li>
102
-
103
- <li class="depth-3">
104
- <a href="#ParameterDecoratorFactory">Class: ParameterDecoratorFactory</a>
105
- </li>
106
-
107
- <li class="depth-4">
108
- <a href="#153232">create</a>
109
- </li>
110
-
111
- <li class="depth-4">
112
- <a href="#153234">createDecorator</a>
113
- </li>
114
-
115
- <li class="depth-3">
116
- <a href="#PropertyDecoratorFactory">Class: PropertyDecoratorFactory</a>
117
- </li>
118
-
119
- <li class="depth-4">
120
- <a href="#153079">create</a>
121
- </li>
122
-
123
- <li class="depth-4">
124
- <a href="#153081">createDecorator</a>
125
- </li>
126
-
127
- <li class="depth-3">
128
- <a href="#DecoratorOptions">Interface: DecoratorOptions</a>
129
- </li>
130
-
131
- <li class="depth-3">
132
- <a href="#MetadataMap">Interface: MetadataMap</a>
133
- </li>
134
-
135
- <li class="depth-3">
136
- <a href="#DecoratorType">Type alias: DecoratorType</a>
137
- </li>
138
-
139
- <li class="depth-3">
140
- <a href="#MetadataInspector">Class: MetadataInspector</a>
141
- </li>
142
-
143
- <li class="depth-4">
144
- <a href="#153390">defineMetadata</a>
145
- </li>
146
-
147
- <li class="depth-4">
148
- <a href="#153397">getAllMethodMetadata</a>
149
- </li>
150
-
151
- <li class="depth-4">
152
- <a href="#153423">getAllParameterMetadata</a>
153
- </li>
154
-
155
- <li class="depth-4">
156
- <a href="#153410">getAllPropertyMetadata</a>
157
- </li>
158
-
159
- <li class="depth-4">
160
- <a href="#153384">getClassMetadata</a>
161
- </li>
162
-
163
- <li class="depth-4">
164
- <a href="#153442">getDesignTypeForMethod</a>
165
- </li>
166
-
167
- <li class="depth-4">
168
- <a href="#153438">getDesignTypeForProperty</a>
169
- </li>
170
-
171
- <li class="depth-4">
172
- <a href="#153403">getMethodMetadata</a>
173
- </li>
174
-
175
- <li class="depth-4">
176
- <a href="#153430">getParameterMetadata</a>
177
- </li>
178
-
179
- <li class="depth-4">
180
- <a href="#153416">getPropertyMetadata</a>
181
- </li>
182
-
183
- <li class="depth-3">
184
- <a href="#DesignTimeMethodMetadata">Interface: DesignTimeMethodMetadata</a>
185
- </li>
186
-
187
- <li class="depth-3">
188
- <a href="#InspectionOptions">Interface: InspectionOptions</a>
189
- </li>
190
-
191
- <li class="depth-3">
192
- <a href="#NamespacedReflect">Class: NamespacedReflect</a>
193
- </li>
194
-
195
- <li class="depth-4">
196
- <a href="#132417">constructor</a>
197
- </li>
198
-
199
- <li class="depth-4">
200
- <a href="#132463">decorate</a>
201
- </li>
202
-
203
- <li class="depth-4">
204
- <a href="#132424">defineMetadata</a>
205
- </li>
206
-
207
- <li class="depth-4">
208
- <a href="#132450">deleteMetadata</a>
209
- </li>
210
-
211
- <li class="depth-4">
212
- <a href="#132430">getMetadata</a>
213
- </li>
214
-
215
- <li class="depth-4">
216
- <a href="#132455">getMetadataKeys</a>
217
- </li>
218
-
219
- <li class="depth-4">
220
- <a href="#132435">getOwnMetadata</a>
221
- </li>
222
-
223
- <li class="depth-4">
224
- <a href="#132459">getOwnMetadataKeys</a>
225
- </li>
226
-
227
- <li class="depth-4">
228
- <a href="#132440">hasMetadata</a>
229
- </li>
230
-
231
- <li class="depth-4">
232
- <a href="#132445">hasOwnMetadata</a>
233
- </li>
234
-
235
- <li class="depth-4">
236
- <a href="#132479">metadata</a>
237
- </li>
238
-
239
- </ul>
240
-
241
- </div>
242
- <div class="col-lg-9 col-lg-offset-3 column" data-spy="scroll" data-target=".scroll-spy-target" data-offset="0">
243
- <div class="readability">
244
-
245
- <section class="code-doc ">
246
- <a name="ClassDecoratorFactory"></a>
247
- <h3 class="code-ref">Class: classdecoratorfactory = new ClassDecoratorFactory()</h3>
248
- <!--
249
- Used for displaying comments in Class, Interface, Properties Constructor,
250
- Function and Parameters of constructor or function.
251
- (Excludes Type alias).
252
- -->
253
-
254
- <div class="code-desc">
255
- <p><p>Factory for class decorators</p>
256
- </p>
257
- <p></p>
258
- </div>
259
-
260
-
261
-
262
-
263
-
264
- </section>
265
-
266
- <section class="code-doc ">
267
- <a name="153006"></a>
268
-
269
- <h4 class="code-ref">create() : ClassDecorator</h4>
270
-
271
-
272
- <!--
273
- Used for displaying comments in Class, Interface, Properties Constructor,
274
- Function and Parameters of constructor or function.
275
- (Excludes Type alias).
276
- -->
277
-
278
-
279
-
280
-
281
-
282
-
283
- </section>
284
-
285
-
286
-
287
- <section class="code-doc ">
288
- <a name="153008"></a>
289
-
290
- <h4 class="code-ref">createDecorator(key: string, spec: T, options: <a href="#DecoratorOptions">DecoratorOptions</a>) : </h4>
291
-
292
-
293
- <!--
294
- Used for displaying comments in Class, Interface, Properties Constructor,
295
- Function and Parameters of constructor or function.
296
- (Excludes Type alias).
297
- -->
298
-
299
- <div class="code-desc">
300
- <p><p>Create a class decorator function</p>
301
- </p>
302
- <p></p>
303
- </div>
304
-
305
-
306
-
307
-
308
-
309
-
310
- <div class="code-arguments-hdr">Arguments</div>
311
- <table class="params code-arguments">
312
- <tr>
313
- <th class="hdr-name">Name</th>
314
- <th class="hdr-type">Type</th>
315
- <th class="hdr-desc">Description</th>
316
- </tr>
317
-
318
- <tr class="code-arg">
319
- <td>
320
- <strong class="code-arg-name">key</strong>
321
- </td>
322
- <td class="code-arg-types">
323
-
324
- <code>string</code>
325
-
326
-
327
- </td>
328
- <td class="code-arg-desc">
329
- <!--
330
- Used for displaying comments in Class, Interface, Properties Constructor,
331
- Function and Parameters of constructor or function.
332
- (Excludes Type alias).
333
- -->
334
-
335
- <div class="code-desc">
336
- <p></p>
337
- <p><p>Metadata key</p>
338
- </p>
339
- </div>
340
-
341
-
342
-
343
-
344
-
345
- </td>
346
- </tr>
347
-
348
- <tr class="code-arg">
349
- <td>
350
- <strong class="code-arg-name">spec</strong>
351
- </td>
352
- <td class="code-arg-types">
353
-
354
- <code>T</code>
355
-
356
-
357
- </td>
358
- <td class="code-arg-desc">
359
- <!--
360
- Used for displaying comments in Class, Interface, Properties Constructor,
361
- Function and Parameters of constructor or function.
362
- (Excludes Type alias).
363
- -->
364
-
365
- <div class="code-desc">
366
- <p></p>
367
- <p><p>Metadata object from the decorator function</p>
368
- </p>
369
- </div>
370
-
371
-
372
-
373
-
374
-
375
- </td>
376
- </tr>
377
-
378
- <tr class="code-arg">
379
- <td>
380
- <strong class="code-arg-name">options</strong>
381
- </td>
382
- <td class="code-arg-types">
383
-
384
- <code><a href="#DecoratorOptions">DecoratorOptions</a></code>
385
-
386
-
387
- </td>
388
- <td class="code-arg-desc">
389
- <!--
390
- Used for displaying comments in Class, Interface, Properties Constructor,
391
- Function and Parameters of constructor or function.
392
- (Excludes Type alias).
393
- -->
394
-
395
- <div class="code-desc">
396
- <p></p>
397
- <p><p>Options for the decorator</p>
398
- </p>
399
- </div>
400
-
401
-
402
-
403
-
404
-
405
- </td>
406
- </tr>
407
-
408
- </table>
409
-
410
- </section>
411
-
412
-
413
-
414
- <section class="code-doc ">
415
- <a name="DecoratorFactory"></a>
416
- <h3 class="code-ref">Class: decoratorfactory = new DecoratorFactory()</h3>
417
- <!--
418
- Used for displaying comments in Class, Interface, Properties Constructor,
419
- Function and Parameters of constructor or function.
420
- (Excludes Type alias).
421
- -->
422
-
423
- <div class="code-desc">
424
- <p><p>Base factory class for decorator functions</p>
425
- </p>
426
- <p></p>
427
- </div>
428
-
429
-
430
-
431
-
432
-
433
- </section>
434
-
435
- <section class="code-doc">
436
- <a name="TODO"></a>
437
- <div class="code-arguments-hdr">Properties</div>
438
- <table class="params code-arguments">
439
- <tr>
440
- <th class="hdr-name">Name</th>
441
- <th class="hdr-type">Type</th>
442
- <th class="hdr-desc">Description</th>
443
- </tr>
444
-
445
- <tr class="code-arg">
446
- <td>
447
- <a name="DecoratorFactory"></a>
448
- <strong class="code-arg-name">TARGET</strong>
449
- </td>
450
- <td class="code-arg-types">
451
-
452
- <code>string</code>
453
-
454
-
455
- </td>
456
- <td class="code-arg-desc">
457
- <!--
458
- Used for displaying comments in Class, Interface, Properties Constructor,
459
- Function and Parameters of constructor or function.
460
- (Excludes Type alias).
461
- -->
462
-
463
- <div class="code-desc">
464
- <p><p>A constant to reference the target of a decoration</p>
465
- </p>
466
- <p></p>
467
- </div>
468
-
469
-
470
-
471
-
472
-
473
- </td>
474
- </tr>
475
-
476
- </table>
477
- </section>
478
-
479
-
480
- <section class="code-doc ">
481
- <a name="152932"></a>
482
-
483
- <h4 class="code-ref">constructor(key: string, spec: T, options: <a href="#DecoratorOptions">DecoratorOptions</a>) : DecoratorFactory</h4>
484
-
485
-
486
- <!--
487
- Used for displaying comments in Class, Interface, Properties Constructor,
488
- Function and Parameters of constructor or function.
489
- (Excludes Type alias).
490
- -->
491
-
492
- <div class="code-desc">
493
- <p><p>Construct a new class decorator factory</p>
494
- </p>
495
- <p></p>
496
- </div>
497
-
498
-
499
-
500
-
501
-
502
-
503
- <div class="code-arguments-hdr">Arguments</div>
504
- <table class="params code-arguments">
505
- <tr>
506
- <th class="hdr-name">Name</th>
507
- <th class="hdr-type">Type</th>
508
- <th class="hdr-desc">Description</th>
509
- </tr>
510
-
511
- <tr class="code-arg">
512
- <td>
513
- <strong class="code-arg-name">key</strong>
514
- </td>
515
- <td class="code-arg-types">
516
-
517
- <code>string</code>
518
-
519
-
520
- </td>
521
- <td class="code-arg-desc">
522
- <!--
523
- Used for displaying comments in Class, Interface, Properties Constructor,
524
- Function and Parameters of constructor or function.
525
- (Excludes Type alias).
526
- -->
527
-
528
- <div class="code-desc">
529
- <p><p>Metadata key</p>
530
- </p>
531
- <p></p>
532
- </div>
533
-
534
-
535
-
536
-
537
-
538
- </td>
539
- </tr>
540
-
541
- <tr class="code-arg">
542
- <td>
543
- <strong class="code-arg-name">spec</strong>
544
- </td>
545
- <td class="code-arg-types">
546
-
547
- <code>T</code>
548
-
549
-
550
- </td>
551
- <td class="code-arg-desc">
552
- <!--
553
- Used for displaying comments in Class, Interface, Properties Constructor,
554
- Function and Parameters of constructor or function.
555
- (Excludes Type alias).
556
- -->
557
-
558
- <div class="code-desc">
559
- <p><p>Metadata object from the decorator function</p>
560
- </p>
561
- <p></p>
562
- </div>
563
-
564
-
565
-
566
-
567
-
568
- </td>
569
- </tr>
570
-
571
- <tr class="code-arg">
572
- <td>
573
- <strong class="code-arg-name">options</strong>
574
- </td>
575
- <td class="code-arg-types">
576
-
577
- <code><a href="#DecoratorOptions">DecoratorOptions</a></code>
578
-
579
-
580
- </td>
581
- <td class="code-arg-desc">
582
- <!--
583
- Used for displaying comments in Class, Interface, Properties Constructor,
584
- Function and Parameters of constructor or function.
585
- (Excludes Type alias).
586
- -->
587
-
588
- <div class="code-desc">
589
- <p><p>Options for the decorator. Default to
590
- <code>{allowInheritance: true}</code> if not provided</p>
591
- </p>
592
- <p></p>
593
- </div>
594
-
595
-
596
-
597
-
598
-
599
- </td>
600
- </tr>
601
-
602
- </table>
603
-
604
- </section>
605
-
606
-
607
- <section class="code-doc ">
608
- <a name="152973"></a>
609
-
610
- <h4 class="code-ref">create() : D</h4>
611
-
612
-
613
- <!--
614
- Used for displaying comments in Class, Interface, Properties Constructor,
615
- Function and Parameters of constructor or function.
616
- (Excludes Type alias).
617
- -->
618
-
619
- <div class="code-desc">
620
- <p><p>Create a decorator function of the given type. Each sub class MUST
621
- implement this method.</p>
622
- </p>
623
- <p></p>
624
- </div>
625
-
626
-
627
-
628
-
629
-
630
-
631
- </section>
632
-
633
-
634
-
635
- <section class="code-doc ">
636
- <a name="152958"></a>
637
-
638
- <h4 class="code-ref">getTarget(spec: T) : any</h4>
639
-
640
-
641
- <!--
642
- Used for displaying comments in Class, Interface, Properties Constructor,
643
- Function and Parameters of constructor or function.
644
- (Excludes Type alias).
645
- -->
646
-
647
- <div class="code-desc">
648
- <p><p>Get the optional decoration target of a given spec</p>
649
- </p>
650
- <p></p>
651
- </div>
652
-
653
-
654
-
655
-
656
-
657
-
658
- <div class="code-arguments-hdr">Arguments</div>
659
- <table class="params code-arguments">
660
- <tr>
661
- <th class="hdr-name">Name</th>
662
- <th class="hdr-type">Type</th>
663
- <th class="hdr-desc">Description</th>
664
- </tr>
665
-
666
- <tr class="code-arg">
667
- <td>
668
- <strong class="code-arg-name">spec</strong>
669
- </td>
670
- <td class="code-arg-types">
671
-
672
- <code>T</code>
673
-
674
-
675
- </td>
676
- <td class="code-arg-desc">
677
- <!--
678
- Used for displaying comments in Class, Interface, Properties Constructor,
679
- Function and Parameters of constructor or function.
680
- (Excludes Type alias).
681
- -->
682
-
683
- <div class="code-desc">
684
- <p></p>
685
- <p><p>Metadata spec</p>
686
- </p>
687
- </div>
688
-
689
-
690
-
691
-
692
-
693
- </td>
694
- </tr>
695
-
696
- </table>
697
-
698
- </section>
699
-
700
-
701
-
702
- <section class="code-doc ">
703
- <a name="152954"></a>
704
-
705
- <h4 class="code-ref">withTarget(spec: T, target: <a href="#Object">Object</a>) : T</h4>
706
-
707
-
708
- <!--
709
- Used for displaying comments in Class, Interface, Properties Constructor,
710
- Function and Parameters of constructor or function.
711
- (Excludes Type alias).
712
- -->
713
-
714
- <div class="code-desc">
715
- <p><p>Set a reference to the target class or prototype for a given spec if
716
- it&#39;s an object</p>
717
- </p>
718
- <p></p>
719
- </div>
720
-
721
-
722
-
723
-
724
-
725
-
726
- <div class="code-arguments-hdr">Arguments</div>
727
- <table class="params code-arguments">
728
- <tr>
729
- <th class="hdr-name">Name</th>
730
- <th class="hdr-type">Type</th>
731
- <th class="hdr-desc">Description</th>
732
- </tr>
733
-
734
- <tr class="code-arg">
735
- <td>
736
- <strong class="code-arg-name">spec</strong>
737
- </td>
738
- <td class="code-arg-types">
739
-
740
- <code>T</code>
741
-
742
-
743
- </td>
744
- <td class="code-arg-desc">
745
- <!--
746
- Used for displaying comments in Class, Interface, Properties Constructor,
747
- Function and Parameters of constructor or function.
748
- (Excludes Type alias).
749
- -->
750
-
751
- <div class="code-desc">
752
- <p></p>
753
- <p><p>Metadata spec</p>
754
- </p>
755
- </div>
756
-
757
-
758
-
759
-
760
-
761
- </td>
762
- </tr>
763
-
764
- <tr class="code-arg">
765
- <td>
766
- <strong class="code-arg-name">target</strong>
767
- </td>
768
- <td class="code-arg-types">
769
-
770
- <code><a href="#Object">Object</a></code>
771
-
772
-
773
- </td>
774
- <td class="code-arg-desc">
775
- <!--
776
- Used for displaying comments in Class, Interface, Properties Constructor,
777
- Function and Parameters of constructor or function.
778
- (Excludes Type alias).
779
- -->
780
-
781
- <div class="code-desc">
782
- <p></p>
783
- <p><p>Target of the decoration. It is a class or the prototype of
784
- a class.</p>
785
- </p>
786
- </div>
787
-
788
-
789
-
790
-
791
-
792
- </td>
793
- </tr>
794
-
795
- </table>
796
-
797
- </section>
798
-
799
-
800
-
801
- <section class="code-doc ">
802
- <a name="152988"></a>
803
-
804
- <h4 class="code-ref">cloneDeep(val: T) : T</h4>
805
-
806
-
807
- <!--
808
- Used for displaying comments in Class, Interface, Properties Constructor,
809
- Function and Parameters of constructor or function.
810
- (Excludes Type alias).
811
- -->
812
-
813
-
814
-
815
-
816
-
817
-
818
- <div class="code-arguments-hdr">Arguments</div>
819
- <table class="params code-arguments">
820
- <tr>
821
- <th class="hdr-name">Name</th>
822
- <th class="hdr-type">Type</th>
823
- <th class="hdr-desc">Description</th>
824
- </tr>
825
-
826
- <tr class="code-arg">
827
- <td>
828
- <strong class="code-arg-name">val</strong>
829
- </td>
830
- <td class="code-arg-types">
831
-
832
- <code>T</code>
833
-
834
-
835
- </td>
836
- <td class="code-arg-desc">
837
- <!--
838
- Used for displaying comments in Class, Interface, Properties Constructor,
839
- Function and Parameters of constructor or function.
840
- (Excludes Type alias).
841
- -->
842
-
843
- <div class="code-desc">
844
- <p><p>Base factory class for decorator functions</p>
845
- </p>
846
- <p></p>
847
- </div>
848
-
849
-
850
-
851
-
852
-
853
- </td>
854
- </tr>
855
-
856
- </table>
857
-
858
- </section>
859
-
860
-
861
-
862
- <section class="code-doc ">
863
- <a name="152950"></a>
864
-
865
- <h4 class="code-ref">getNumberOfParameters(target: <a href="#Object">Object</a>, member: undefined) : number</h4>
866
-
867
-
868
- <!--
869
- Used for displaying comments in Class, Interface, Properties Constructor,
870
- Function and Parameters of constructor or function.
871
- (Excludes Type alias).
872
- -->
873
-
874
- <div class="code-desc">
875
- <p><p>Get the number of parameters for a given constructor or method</p>
876
- </p>
877
- <p></p>
878
- </div>
879
-
880
-
881
-
882
-
883
-
884
-
885
- <div class="code-arguments-hdr">Arguments</div>
886
- <table class="params code-arguments">
887
- <tr>
888
- <th class="hdr-name">Name</th>
889
- <th class="hdr-type">Type</th>
890
- <th class="hdr-desc">Description</th>
891
- </tr>
892
-
893
- <tr class="code-arg">
894
- <td>
895
- <strong class="code-arg-name">target</strong>
896
- </td>
897
- <td class="code-arg-types">
898
-
899
- <code><a href="#Object">Object</a></code>
900
-
901
-
902
- </td>
903
- <td class="code-arg-desc">
904
- <!--
905
- Used for displaying comments in Class, Interface, Properties Constructor,
906
- Function and Parameters of constructor or function.
907
- (Excludes Type alias).
908
- -->
909
-
910
- <div class="code-desc">
911
- <p></p>
912
- <p><p>Class or the prototype</p>
913
- </p>
914
- </div>
915
-
916
-
917
-
918
-
919
-
920
- </td>
921
- </tr>
922
-
923
- <tr class="code-arg">
924
- <td>
925
- <strong class="code-arg-name">member</strong>
926
- </td>
927
- <td class="code-arg-types">
928
-
929
- <code></code>
930
-
931
-
932
- </td>
933
- <td class="code-arg-desc">
934
- <!--
935
- Used for displaying comments in Class, Interface, Properties Constructor,
936
- Function and Parameters of constructor or function.
937
- (Excludes Type alias).
938
- -->
939
-
940
- <div class="code-desc">
941
- <p></p>
942
- <p><p>Method name</p>
943
- </p>
944
- </div>
945
-
946
-
947
-
948
-
949
-
950
- </td>
951
- </tr>
952
-
953
- </table>
954
-
955
- </section>
956
-
957
-
958
-
959
- <section class="code-doc ">
960
- <a name="152945"></a>
961
-
962
- <h4 class="code-ref">getTargetName(target: <a href="#Object">Object</a>, member: undefined, descriptorOrIndex: undefined) : string</h4>
963
-
964
-
965
- <!--
966
- Used for displaying comments in Class, Interface, Properties Constructor,
967
- Function and Parameters of constructor or function.
968
- (Excludes Type alias).
969
- -->
970
-
971
- <div class="code-desc">
972
- <p><p><p>Get the qualified name of a decoration target. For example:</p></p>
973
- <pre><code>class MyClass
974
- MyClass<span class="hljs-selector-class">.constructor</span>[<span class="hljs-number">0</span>] <span class="hljs-comment">// First parameter of the constructor</span>
975
- MyClass<span class="hljs-selector-class">.myStaticProperty</span>
976
- MyClass.myStaticMethod()
977
- MyClass<span class="hljs-selector-class">.myStaticMethod</span>[<span class="hljs-number">0</span>] <span class="hljs-comment">// First parameter of the myStaticMethod</span>
978
- MyClass<span class="hljs-selector-class">.prototype</span><span class="hljs-selector-class">.myProperty</span>
979
- MyClass<span class="hljs-selector-class">.prototype</span><span class="hljs-selector-class">.myMethod</span>()
980
- MyClass<span class="hljs-selector-class">.prototype</span><span class="hljs-selector-class">.myMethod</span>[<span class="hljs-number">1</span>] <span class="hljs-comment">// Second parameter of myMethod</span>
981
- </code></pre></p>
982
- <p></p>
983
- </div>
984
-
985
-
986
-
987
-
988
-
989
-
990
- <div class="code-arguments-hdr">Arguments</div>
991
- <table class="params code-arguments">
992
- <tr>
993
- <th class="hdr-name">Name</th>
994
- <th class="hdr-type">Type</th>
995
- <th class="hdr-desc">Description</th>
996
- </tr>
997
-
998
- <tr class="code-arg">
999
- <td>
1000
- <strong class="code-arg-name">target</strong>
1001
- </td>
1002
- <td class="code-arg-types">
1003
-
1004
- <code><a href="#Object">Object</a></code>
1005
-
1006
-
1007
- </td>
1008
- <td class="code-arg-desc">
1009
- <!--
1010
- Used for displaying comments in Class, Interface, Properties Constructor,
1011
- Function and Parameters of constructor or function.
1012
- (Excludes Type alias).
1013
- -->
1014
-
1015
- <div class="code-desc">
1016
- <p></p>
1017
- <p><p>Class or prototype of a class</p>
1018
- </p>
1019
- </div>
1020
-
1021
-
1022
-
1023
-
1024
-
1025
- </td>
1026
- </tr>
1027
-
1028
- <tr class="code-arg">
1029
- <td>
1030
- <strong class="code-arg-name">member</strong>
1031
- </td>
1032
- <td class="code-arg-types">
1033
-
1034
- <code></code>
1035
-
1036
-
1037
- </td>
1038
- <td class="code-arg-desc">
1039
- <!--
1040
- Used for displaying comments in Class, Interface, Properties Constructor,
1041
- Function and Parameters of constructor or function.
1042
- (Excludes Type alias).
1043
- -->
1044
-
1045
- <div class="code-desc">
1046
- <p></p>
1047
- <p><p>Optional property/method name</p>
1048
- </p>
1049
- </div>
1050
-
1051
-
1052
-
1053
-
1054
-
1055
- </td>
1056
- </tr>
1057
-
1058
- <tr class="code-arg">
1059
- <td>
1060
- <strong class="code-arg-name">descriptorOrIndex</strong>
1061
- </td>
1062
- <td class="code-arg-types">
1063
-
1064
- <code></code>
1065
-
1066
-
1067
- </td>
1068
- <td class="code-arg-desc">
1069
- <!--
1070
- Used for displaying comments in Class, Interface, Properties Constructor,
1071
- Function and Parameters of constructor or function.
1072
- (Excludes Type alias).
1073
- -->
1074
-
1075
- <div class="code-desc">
1076
- <p></p>
1077
- <p><p>Optional method descriptor or parameter index</p>
1078
- </p>
1079
- </div>
1080
-
1081
-
1082
-
1083
-
1084
-
1085
- </td>
1086
- </tr>
1087
-
1088
- </table>
1089
-
1090
- </section>
1091
-
1092
-
1093
-
1094
- <section class="code-doc ">
1095
- <a name="MethodDecoratorFactory"></a>
1096
- <h3 class="code-ref">Class: methoddecoratorfactory = new MethodDecoratorFactory()</h3>
1097
- <!--
1098
- Used for displaying comments in Class, Interface, Properties Constructor,
1099
- Function and Parameters of constructor or function.
1100
- (Excludes Type alias).
1101
- -->
1102
-
1103
- <div class="code-desc">
1104
- <p><p>Factory for method decorators</p>
1105
- </p>
1106
- <p></p>
1107
- </div>
1108
-
1109
-
1110
-
1111
-
1112
-
1113
- </section>
1114
-
1115
- <section class="code-doc ">
1116
- <a name="153152"></a>
1117
-
1118
- <h4 class="code-ref">create() : MethodDecorator</h4>
1119
-
1120
-
1121
- <!--
1122
- Used for displaying comments in Class, Interface, Properties Constructor,
1123
- Function and Parameters of constructor or function.
1124
- (Excludes Type alias).
1125
- -->
1126
-
1127
-
1128
-
1129
-
1130
-
1131
-
1132
- </section>
1133
-
1134
-
1135
-
1136
- <section class="code-doc ">
1137
- <a name="153154"></a>
1138
-
1139
- <h4 class="code-ref">createDecorator(key: string, spec: T, options: <a href="#DecoratorOptions">DecoratorOptions</a>) : </h4>
1140
-
1141
-
1142
- <!--
1143
- Used for displaying comments in Class, Interface, Properties Constructor,
1144
- Function and Parameters of constructor or function.
1145
- (Excludes Type alias).
1146
- -->
1147
-
1148
- <div class="code-desc">
1149
- <p><p>Create a method decorator function</p>
1150
- </p>
1151
- <p></p>
1152
- </div>
1153
-
1154
-
1155
-
1156
-
1157
-
1158
-
1159
- <div class="code-arguments-hdr">Arguments</div>
1160
- <table class="params code-arguments">
1161
- <tr>
1162
- <th class="hdr-name">Name</th>
1163
- <th class="hdr-type">Type</th>
1164
- <th class="hdr-desc">Description</th>
1165
- </tr>
1166
-
1167
- <tr class="code-arg">
1168
- <td>
1169
- <strong class="code-arg-name">key</strong>
1170
- </td>
1171
- <td class="code-arg-types">
1172
-
1173
- <code>string</code>
1174
-
1175
-
1176
- </td>
1177
- <td class="code-arg-desc">
1178
- <!--
1179
- Used for displaying comments in Class, Interface, Properties Constructor,
1180
- Function and Parameters of constructor or function.
1181
- (Excludes Type alias).
1182
- -->
1183
-
1184
- <div class="code-desc">
1185
- <p></p>
1186
- <p><p>Metadata key</p>
1187
- </p>
1188
- </div>
1189
-
1190
-
1191
-
1192
-
1193
-
1194
- </td>
1195
- </tr>
1196
-
1197
- <tr class="code-arg">
1198
- <td>
1199
- <strong class="code-arg-name">spec</strong>
1200
- </td>
1201
- <td class="code-arg-types">
1202
-
1203
- <code>T</code>
1204
-
1205
-
1206
- </td>
1207
- <td class="code-arg-desc">
1208
- <!--
1209
- Used for displaying comments in Class, Interface, Properties Constructor,
1210
- Function and Parameters of constructor or function.
1211
- (Excludes Type alias).
1212
- -->
1213
-
1214
- <div class="code-desc">
1215
- <p></p>
1216
- <p><p>Metadata object from the decorator function</p>
1217
- </p>
1218
- </div>
1219
-
1220
-
1221
-
1222
-
1223
-
1224
- </td>
1225
- </tr>
1226
-
1227
- <tr class="code-arg">
1228
- <td>
1229
- <strong class="code-arg-name">options</strong>
1230
- </td>
1231
- <td class="code-arg-types">
1232
-
1233
- <code><a href="#DecoratorOptions">DecoratorOptions</a></code>
1234
-
1235
-
1236
- </td>
1237
- <td class="code-arg-desc">
1238
- <!--
1239
- Used for displaying comments in Class, Interface, Properties Constructor,
1240
- Function and Parameters of constructor or function.
1241
- (Excludes Type alias).
1242
- -->
1243
-
1244
- <div class="code-desc">
1245
- <p></p>
1246
- <p><p>Options for the decorator</p>
1247
- </p>
1248
- </div>
1249
-
1250
-
1251
-
1252
-
1253
-
1254
- </td>
1255
- </tr>
1256
-
1257
- </table>
1258
-
1259
- </section>
1260
-
1261
-
1262
-
1263
- <section class="code-doc ">
1264
- <a name="MethodParameterDecoratorFactory"></a>
1265
- <h3 class="code-ref">Class: methodparameterdecoratorfactory = new MethodParameterDecoratorFactory()</h3>
1266
- <!--
1267
- Used for displaying comments in Class, Interface, Properties Constructor,
1268
- Function and Parameters of constructor or function.
1269
- (Excludes Type alias).
1270
- -->
1271
-
1272
- <div class="code-desc">
1273
- <p><p>Factory for method level parameter decorator. For example, the following
1274
- code uses <code>@param</code> to declare two parameters for <code>greet()</code>.</p>
1275
- <pre><code class="lang-ts"><span class="hljs-keyword">class</span> MyController {
1276
- <span class="hljs-meta">@param</span>(<span class="hljs-string">'name'</span>) <span class="hljs-comment">// Parameter 0</span>
1277
- <span class="hljs-meta">@param</span>(<span class="hljs-string">'msg'</span>) <span class="hljs-comment">// Parameter 1</span>
1278
- greet() {}
1279
- }
1280
- </code></pre>
1281
- </p>
1282
- <p></p>
1283
- </div>
1284
-
1285
-
1286
-
1287
-
1288
-
1289
- </section>
1290
-
1291
- <section class="code-doc ">
1292
- <a name="153311"></a>
1293
-
1294
- <h4 class="code-ref">create() : MethodDecorator</h4>
1295
-
1296
-
1297
- <!--
1298
- Used for displaying comments in Class, Interface, Properties Constructor,
1299
- Function and Parameters of constructor or function.
1300
- (Excludes Type alias).
1301
- -->
1302
-
1303
-
1304
-
1305
-
1306
-
1307
-
1308
- </section>
1309
-
1310
-
1311
-
1312
- <section class="code-doc ">
1313
- <a name="153313"></a>
1314
-
1315
- <h4 class="code-ref">createDecorator(key: string, spec: T, options: <a href="#DecoratorOptions">DecoratorOptions</a>) : </h4>
1316
-
1317
-
1318
- <!--
1319
- Used for displaying comments in Class, Interface, Properties Constructor,
1320
- Function and Parameters of constructor or function.
1321
- (Excludes Type alias).
1322
- -->
1323
-
1324
- <div class="code-desc">
1325
- <p><p>Create a method decorator function</p>
1326
- </p>
1327
- <p></p>
1328
- </div>
1329
-
1330
-
1331
-
1332
-
1333
-
1334
-
1335
- <div class="code-arguments-hdr">Arguments</div>
1336
- <table class="params code-arguments">
1337
- <tr>
1338
- <th class="hdr-name">Name</th>
1339
- <th class="hdr-type">Type</th>
1340
- <th class="hdr-desc">Description</th>
1341
- </tr>
1342
-
1343
- <tr class="code-arg">
1344
- <td>
1345
- <strong class="code-arg-name">key</strong>
1346
- </td>
1347
- <td class="code-arg-types">
1348
-
1349
- <code>string</code>
1350
-
1351
-
1352
- </td>
1353
- <td class="code-arg-desc">
1354
- <!--
1355
- Used for displaying comments in Class, Interface, Properties Constructor,
1356
- Function and Parameters of constructor or function.
1357
- (Excludes Type alias).
1358
- -->
1359
-
1360
- <div class="code-desc">
1361
- <p></p>
1362
- <p><p>Metadata key</p>
1363
- </p>
1364
- </div>
1365
-
1366
-
1367
-
1368
-
1369
-
1370
- </td>
1371
- </tr>
1372
-
1373
- <tr class="code-arg">
1374
- <td>
1375
- <strong class="code-arg-name">spec</strong>
1376
- </td>
1377
- <td class="code-arg-types">
1378
-
1379
- <code>T</code>
1380
-
1381
-
1382
- </td>
1383
- <td class="code-arg-desc">
1384
- <!--
1385
- Used for displaying comments in Class, Interface, Properties Constructor,
1386
- Function and Parameters of constructor or function.
1387
- (Excludes Type alias).
1388
- -->
1389
-
1390
- <div class="code-desc">
1391
- <p></p>
1392
- <p><p>Metadata object from the decorator function</p>
1393
- </p>
1394
- </div>
1395
-
1396
-
1397
-
1398
-
1399
-
1400
- </td>
1401
- </tr>
1402
-
1403
- <tr class="code-arg">
1404
- <td>
1405
- <strong class="code-arg-name">options</strong>
1406
- </td>
1407
- <td class="code-arg-types">
1408
-
1409
- <code><a href="#DecoratorOptions">DecoratorOptions</a></code>
1410
-
1411
-
1412
- </td>
1413
- <td class="code-arg-desc">
1414
- <!--
1415
- Used for displaying comments in Class, Interface, Properties Constructor,
1416
- Function and Parameters of constructor or function.
1417
- (Excludes Type alias).
1418
- -->
1419
-
1420
- <div class="code-desc">
1421
- <p></p>
1422
- <p><p>Options for the decorator</p>
1423
- </p>
1424
- </div>
1425
-
1426
-
1427
-
1428
-
1429
-
1430
- </td>
1431
- </tr>
1432
-
1433
- </table>
1434
-
1435
- </section>
1436
-
1437
-
1438
-
1439
- <section class="code-doc ">
1440
- <a name="ParameterDecoratorFactory"></a>
1441
- <h3 class="code-ref">Class: parameterdecoratorfactory = new ParameterDecoratorFactory()</h3>
1442
- <!--
1443
- Used for displaying comments in Class, Interface, Properties Constructor,
1444
- Function and Parameters of constructor or function.
1445
- (Excludes Type alias).
1446
- -->
1447
-
1448
- <div class="code-desc">
1449
- <p><p>Factory for parameter decorators</p>
1450
- </p>
1451
- <p></p>
1452
- </div>
1453
-
1454
-
1455
-
1456
-
1457
-
1458
- </section>
1459
-
1460
- <section class="code-doc ">
1461
- <a name="153232"></a>
1462
-
1463
- <h4 class="code-ref">create() : ParameterDecorator</h4>
1464
-
1465
-
1466
- <!--
1467
- Used for displaying comments in Class, Interface, Properties Constructor,
1468
- Function and Parameters of constructor or function.
1469
- (Excludes Type alias).
1470
- -->
1471
-
1472
-
1473
-
1474
-
1475
-
1476
-
1477
- </section>
1478
-
1479
-
1480
-
1481
- <section class="code-doc ">
1482
- <a name="153234"></a>
1483
-
1484
- <h4 class="code-ref">createDecorator(key: string, spec: T, options: <a href="#DecoratorOptions">DecoratorOptions</a>) : </h4>
1485
-
1486
-
1487
- <!--
1488
- Used for displaying comments in Class, Interface, Properties Constructor,
1489
- Function and Parameters of constructor or function.
1490
- (Excludes Type alias).
1491
- -->
1492
-
1493
- <div class="code-desc">
1494
- <p><p>Create a parameter decorator function</p>
1495
- </p>
1496
- <p></p>
1497
- </div>
1498
-
1499
-
1500
-
1501
-
1502
-
1503
-
1504
- <div class="code-arguments-hdr">Arguments</div>
1505
- <table class="params code-arguments">
1506
- <tr>
1507
- <th class="hdr-name">Name</th>
1508
- <th class="hdr-type">Type</th>
1509
- <th class="hdr-desc">Description</th>
1510
- </tr>
1511
-
1512
- <tr class="code-arg">
1513
- <td>
1514
- <strong class="code-arg-name">key</strong>
1515
- </td>
1516
- <td class="code-arg-types">
1517
-
1518
- <code>string</code>
1519
-
1520
-
1521
- </td>
1522
- <td class="code-arg-desc">
1523
- <!--
1524
- Used for displaying comments in Class, Interface, Properties Constructor,
1525
- Function and Parameters of constructor or function.
1526
- (Excludes Type alias).
1527
- -->
1528
-
1529
- <div class="code-desc">
1530
- <p></p>
1531
- <p><p>Metadata key</p>
1532
- </p>
1533
- </div>
1534
-
1535
-
1536
-
1537
-
1538
-
1539
- </td>
1540
- </tr>
1541
-
1542
- <tr class="code-arg">
1543
- <td>
1544
- <strong class="code-arg-name">spec</strong>
1545
- </td>
1546
- <td class="code-arg-types">
1547
-
1548
- <code>T</code>
1549
-
1550
-
1551
- </td>
1552
- <td class="code-arg-desc">
1553
- <!--
1554
- Used for displaying comments in Class, Interface, Properties Constructor,
1555
- Function and Parameters of constructor or function.
1556
- (Excludes Type alias).
1557
- -->
1558
-
1559
- <div class="code-desc">
1560
- <p></p>
1561
- <p><p>Metadata object from the decorator function</p>
1562
- </p>
1563
- </div>
1564
-
1565
-
1566
-
1567
-
1568
-
1569
- </td>
1570
- </tr>
1571
-
1572
- <tr class="code-arg">
1573
- <td>
1574
- <strong class="code-arg-name">options</strong>
1575
- </td>
1576
- <td class="code-arg-types">
1577
-
1578
- <code><a href="#DecoratorOptions">DecoratorOptions</a></code>
1579
-
1580
-
1581
- </td>
1582
- <td class="code-arg-desc">
1583
- <!--
1584
- Used for displaying comments in Class, Interface, Properties Constructor,
1585
- Function and Parameters of constructor or function.
1586
- (Excludes Type alias).
1587
- -->
1588
-
1589
- <div class="code-desc">
1590
- <p></p>
1591
- <p><p>Options for the decorator</p>
1592
- </p>
1593
- </div>
1594
-
1595
-
1596
-
1597
-
1598
-
1599
- </td>
1600
- </tr>
1601
-
1602
- </table>
1603
-
1604
- </section>
1605
-
1606
-
1607
-
1608
- <section class="code-doc ">
1609
- <a name="PropertyDecoratorFactory"></a>
1610
- <h3 class="code-ref">Class: propertydecoratorfactory = new PropertyDecoratorFactory()</h3>
1611
- <!--
1612
- Used for displaying comments in Class, Interface, Properties Constructor,
1613
- Function and Parameters of constructor or function.
1614
- (Excludes Type alias).
1615
- -->
1616
-
1617
- <div class="code-desc">
1618
- <p><p>Factory for property decorators</p>
1619
- </p>
1620
- <p></p>
1621
- </div>
1622
-
1623
-
1624
-
1625
-
1626
-
1627
- </section>
1628
-
1629
- <section class="code-doc ">
1630
- <a name="153079"></a>
1631
-
1632
- <h4 class="code-ref">create() : PropertyDecorator</h4>
1633
-
1634
-
1635
- <!--
1636
- Used for displaying comments in Class, Interface, Properties Constructor,
1637
- Function and Parameters of constructor or function.
1638
- (Excludes Type alias).
1639
- -->
1640
-
1641
-
1642
-
1643
-
1644
-
1645
-
1646
- </section>
1647
-
1648
-
1649
-
1650
- <section class="code-doc ">
1651
- <a name="153081"></a>
1652
-
1653
- <h4 class="code-ref">createDecorator(key: string, spec: T, options: <a href="#DecoratorOptions">DecoratorOptions</a>) : </h4>
1654
-
1655
-
1656
- <!--
1657
- Used for displaying comments in Class, Interface, Properties Constructor,
1658
- Function and Parameters of constructor or function.
1659
- (Excludes Type alias).
1660
- -->
1661
-
1662
- <div class="code-desc">
1663
- <p><p>Create a property decorator function</p>
1664
- </p>
1665
- <p></p>
1666
- </div>
1667
-
1668
-
1669
-
1670
-
1671
-
1672
-
1673
- <div class="code-arguments-hdr">Arguments</div>
1674
- <table class="params code-arguments">
1675
- <tr>
1676
- <th class="hdr-name">Name</th>
1677
- <th class="hdr-type">Type</th>
1678
- <th class="hdr-desc">Description</th>
1679
- </tr>
1680
-
1681
- <tr class="code-arg">
1682
- <td>
1683
- <strong class="code-arg-name">key</strong>
1684
- </td>
1685
- <td class="code-arg-types">
1686
-
1687
- <code>string</code>
1688
-
1689
-
1690
- </td>
1691
- <td class="code-arg-desc">
1692
- <!--
1693
- Used for displaying comments in Class, Interface, Properties Constructor,
1694
- Function and Parameters of constructor or function.
1695
- (Excludes Type alias).
1696
- -->
1697
-
1698
- <div class="code-desc">
1699
- <p></p>
1700
- <p><p>Metadata key</p>
1701
- </p>
1702
- </div>
1703
-
1704
-
1705
-
1706
-
1707
-
1708
- </td>
1709
- </tr>
1710
-
1711
- <tr class="code-arg">
1712
- <td>
1713
- <strong class="code-arg-name">spec</strong>
1714
- </td>
1715
- <td class="code-arg-types">
1716
-
1717
- <code>T</code>
1718
-
1719
-
1720
- </td>
1721
- <td class="code-arg-desc">
1722
- <!--
1723
- Used for displaying comments in Class, Interface, Properties Constructor,
1724
- Function and Parameters of constructor or function.
1725
- (Excludes Type alias).
1726
- -->
1727
-
1728
- <div class="code-desc">
1729
- <p></p>
1730
- <p><p>Metadata object from the decorator function</p>
1731
- </p>
1732
- </div>
1733
-
1734
-
1735
-
1736
-
1737
-
1738
- </td>
1739
- </tr>
1740
-
1741
- <tr class="code-arg">
1742
- <td>
1743
- <strong class="code-arg-name">options</strong>
1744
- </td>
1745
- <td class="code-arg-types">
1746
-
1747
- <code><a href="#DecoratorOptions">DecoratorOptions</a></code>
1748
-
1749
-
1750
- </td>
1751
- <td class="code-arg-desc">
1752
- <!--
1753
- Used for displaying comments in Class, Interface, Properties Constructor,
1754
- Function and Parameters of constructor or function.
1755
- (Excludes Type alias).
1756
- -->
1757
-
1758
- <div class="code-desc">
1759
- <p></p>
1760
- <p><p>Options for the decorator</p>
1761
- </p>
1762
- </div>
1763
-
1764
-
1765
-
1766
-
1767
-
1768
- </td>
1769
- </tr>
1770
-
1771
- </table>
1772
-
1773
- </section>
1774
-
1775
-
1776
-
1777
- <section class="code-doc ">
1778
- <a name="DecoratorOptions"></a>
1779
- <h3 class="code-ref">Interface: DecoratorOptions</h3>
1780
- <!--
1781
- Used for displaying comments in Class, Interface, Properties Constructor,
1782
- Function and Parameters of constructor or function.
1783
- (Excludes Type alias).
1784
- -->
1785
-
1786
- <div class="code-desc">
1787
- <p><p>Options for a decorator</p>
1788
- </p>
1789
- <p></p>
1790
- </div>
1791
-
1792
-
1793
-
1794
-
1795
-
1796
- </section>
1797
-
1798
- <section class="code-doc">
1799
- <a name="TODO"></a>
1800
- <div class="code-arguments-hdr">Properties</div>
1801
- <table class="params code-arguments">
1802
- <tr>
1803
- <th class="hdr-name">Name</th>
1804
- <th class="hdr-type">Type</th>
1805
- <th class="hdr-desc">Description</th>
1806
- </tr>
1807
-
1808
- <tr class="code-arg">
1809
- <td>
1810
- <a name="DecoratorOptions"></a>
1811
- <strong class="code-arg-name">allowInheritance</strong>
1812
- </td>
1813
- <td class="code-arg-types">
1814
-
1815
- <code></code>
1816
-
1817
-
1818
- </td>
1819
- <td class="code-arg-desc">
1820
- <!--
1821
- Used for displaying comments in Class, Interface, Properties Constructor,
1822
- Function and Parameters of constructor or function.
1823
- (Excludes Type alias).
1824
- -->
1825
-
1826
- <div class="code-desc">
1827
- <p><p>Controls if inherited metadata will be honored. Default to <code>true</code>.</p>
1828
- </p>
1829
- <p></p>
1830
- </div>
1831
-
1832
-
1833
-
1834
-
1835
-
1836
- </td>
1837
- </tr>
1838
-
1839
- <tr class="code-arg">
1840
- <td>
1841
- <a name="DecoratorOptions"></a>
1842
- <strong class="code-arg-name">cloneInputSpec</strong>
1843
- </td>
1844
- <td class="code-arg-types">
1845
-
1846
- <code></code>
1847
-
1848
-
1849
- </td>
1850
- <td class="code-arg-desc">
1851
- <!--
1852
- Used for displaying comments in Class, Interface, Properties Constructor,
1853
- Function and Parameters of constructor or function.
1854
- (Excludes Type alias).
1855
- -->
1856
-
1857
- <div class="code-desc">
1858
- <p><p>Controls if the value of <code>spec</code> argument will be cloned. Sometimes we
1859
- use shared spec for the decoration, but the decorator function might need
1860
- to mutate the object. Cloning the input spec makes it safe to use the same
1861
- spec (<code>template</code>) to decorate different members.</p>
1862
- </p>
1863
- <p><p>Default to <code>true</code>.</p>
1864
- </p>
1865
- </div>
1866
-
1867
-
1868
-
1869
-
1870
-
1871
- </td>
1872
- </tr>
1873
-
1874
- </table>
1875
- </section>
1876
-
1877
-
1878
- <section class="code-doc ">
1879
- <a name="MetadataMap"></a>
1880
- <h3 class="code-ref">Interface: MetadataMap</h3>
1881
- <!--
1882
- Used for displaying comments in Class, Interface, Properties Constructor,
1883
- Function and Parameters of constructor or function.
1884
- (Excludes Type alias).
1885
- -->
1886
-
1887
- <div class="code-desc">
1888
- <p><p>An object mapping keys to corresponding metadata</p>
1889
- </p>
1890
- <p></p>
1891
- </div>
1892
-
1893
-
1894
-
1895
-
1896
-
1897
- </section>
1898
-
1899
-
1900
- <section class="code-doc ">
1901
- <a name="MetadataInspector"></a>
1902
- <h3 class="code-ref">Class: metadatainspector = new MetadataInspector()</h3>
1903
- <!--
1904
- Used for displaying comments in Class, Interface, Properties Constructor,
1905
- Function and Parameters of constructor or function.
1906
- (Excludes Type alias).
1907
- -->
1908
-
1909
- <div class="code-desc">
1910
- <p><p>Inspector for metadata applied by decorators</p>
1911
- </p>
1912
- <p></p>
1913
- </div>
1914
-
1915
-
1916
-
1917
-
1918
-
1919
- </section>
1920
-
1921
- <section class="code-doc">
1922
- <a name="TODO"></a>
1923
- <div class="code-arguments-hdr">Properties</div>
1924
- <table class="params code-arguments">
1925
- <tr>
1926
- <th class="hdr-name">Name</th>
1927
- <th class="hdr-type">Type</th>
1928
- <th class="hdr-desc">Description</th>
1929
- </tr>
1930
-
1931
- <tr class="code-arg">
1932
- <td>
1933
- <a name="MetadataInspector"></a>
1934
- <strong class="code-arg-name">DesignTimeReflector</strong>
1935
- </td>
1936
- <td class="code-arg-types">
1937
-
1938
- <code><a href="#NamespacedReflect">NamespacedReflect</a></code>
1939
-
1940
-
1941
- </td>
1942
- <td class="code-arg-desc">
1943
- <!--
1944
- Used for displaying comments in Class, Interface, Properties Constructor,
1945
- Function and Parameters of constructor or function.
1946
- (Excludes Type alias).
1947
- -->
1948
-
1949
- <div class="code-desc">
1950
- <p><p>Expose the reflector for TypeScript design-time metadata</p>
1951
- </p>
1952
- <p></p>
1953
- </div>
1954
-
1955
-
1956
-
1957
-
1958
-
1959
- </td>
1960
- </tr>
1961
-
1962
- <tr class="code-arg">
1963
- <td>
1964
- <a name="MetadataInspector"></a>
1965
- <strong class="code-arg-name">Reflector</strong>
1966
- </td>
1967
- <td class="code-arg-types">
1968
-
1969
- <code><a href="#NamespacedReflect">NamespacedReflect</a></code>
1970
-
1971
-
1972
- </td>
1973
- <td class="code-arg-desc">
1974
- <!--
1975
- Used for displaying comments in Class, Interface, Properties Constructor,
1976
- Function and Parameters of constructor or function.
1977
- (Excludes Type alias).
1978
- -->
1979
-
1980
- <div class="code-desc">
1981
- <p><p>Expose Reflector, which is a wrapper of <code>Reflect</code> and it uses <code>loopback</code>
1982
- as the namespace prefix for all metadata keys</p>
1983
- </p>
1984
- <p></p>
1985
- </div>
1986
-
1987
-
1988
-
1989
-
1990
-
1991
- </td>
1992
- </tr>
1993
-
1994
- </table>
1995
- </section>
1996
-
1997
-
1998
- <section class="code-doc ">
1999
- <a name="153390"></a>
2000
-
2001
- <h4 class="code-ref">defineMetadata(key: string, value: T, target: <a href="#Object">Object</a>, member: undefined) : void</h4>
2002
-
2003
-
2004
- <!--
2005
- Used for displaying comments in Class, Interface, Properties Constructor,
2006
- Function and Parameters of constructor or function.
2007
- (Excludes Type alias).
2008
- -->
2009
-
2010
- <div class="code-desc">
2011
- <p><p>Define metadata for the given target</p>
2012
- </p>
2013
- <p></p>
2014
- </div>
2015
-
2016
-
2017
-
2018
-
2019
-
2020
-
2021
- <div class="code-arguments-hdr">Arguments</div>
2022
- <table class="params code-arguments">
2023
- <tr>
2024
- <th class="hdr-name">Name</th>
2025
- <th class="hdr-type">Type</th>
2026
- <th class="hdr-desc">Description</th>
2027
- </tr>
2028
-
2029
- <tr class="code-arg">
2030
- <td>
2031
- <strong class="code-arg-name">key</strong>
2032
- </td>
2033
- <td class="code-arg-types">
2034
-
2035
- <code>string</code>
2036
-
2037
-
2038
- </td>
2039
- <td class="code-arg-desc">
2040
- <!--
2041
- Used for displaying comments in Class, Interface, Properties Constructor,
2042
- Function and Parameters of constructor or function.
2043
- (Excludes Type alias).
2044
- -->
2045
-
2046
- <div class="code-desc">
2047
- <p></p>
2048
- <p><p>Metadata key</p>
2049
- </p>
2050
- </div>
2051
-
2052
-
2053
-
2054
-
2055
-
2056
- </td>
2057
- </tr>
2058
-
2059
- <tr class="code-arg">
2060
- <td>
2061
- <strong class="code-arg-name">value</strong>
2062
- </td>
2063
- <td class="code-arg-types">
2064
-
2065
- <code>T</code>
2066
-
2067
-
2068
- </td>
2069
- <td class="code-arg-desc">
2070
- <!--
2071
- Used for displaying comments in Class, Interface, Properties Constructor,
2072
- Function and Parameters of constructor or function.
2073
- (Excludes Type alias).
2074
- -->
2075
-
2076
- <div class="code-desc">
2077
- <p></p>
2078
- <p><p>Metadata value</p>
2079
- </p>
2080
- </div>
2081
-
2082
-
2083
-
2084
-
2085
-
2086
- </td>
2087
- </tr>
2088
-
2089
- <tr class="code-arg">
2090
- <td>
2091
- <strong class="code-arg-name">target</strong>
2092
- </td>
2093
- <td class="code-arg-types">
2094
-
2095
- <code><a href="#Object">Object</a></code>
2096
-
2097
-
2098
- </td>
2099
- <td class="code-arg-desc">
2100
- <!--
2101
- Used for displaying comments in Class, Interface, Properties Constructor,
2102
- Function and Parameters of constructor or function.
2103
- (Excludes Type alias).
2104
- -->
2105
-
2106
- <div class="code-desc">
2107
- <p></p>
2108
- <p><p>Target for the metadata</p>
2109
- </p>
2110
- </div>
2111
-
2112
-
2113
-
2114
-
2115
-
2116
- </td>
2117
- </tr>
2118
-
2119
- <tr class="code-arg">
2120
- <td>
2121
- <strong class="code-arg-name">member</strong>
2122
- </td>
2123
- <td class="code-arg-types">
2124
-
2125
- <code></code>
2126
-
2127
-
2128
- </td>
2129
- <td class="code-arg-desc">
2130
- <!--
2131
- Used for displaying comments in Class, Interface, Properties Constructor,
2132
- Function and Parameters of constructor or function.
2133
- (Excludes Type alias).
2134
- -->
2135
-
2136
- <div class="code-desc">
2137
- <p></p>
2138
- <p><p>Optional property or method name</p>
2139
- </p>
2140
- </div>
2141
-
2142
-
2143
-
2144
-
2145
-
2146
- </td>
2147
- </tr>
2148
-
2149
- </table>
2150
-
2151
- </section>
2152
-
2153
-
2154
-
2155
- <section class="code-doc ">
2156
- <a name="153397"></a>
2157
-
2158
- <h4 class="code-ref">getAllMethodMetadata(key: string, target: <a href="#Object">Object</a>, options: <a href="#InspectionOptions">InspectionOptions</a>) : <a href="#MetadataMap">MetadataMap</a> | undefined</h4>
2159
-
2160
-
2161
- <!--
2162
- Used for displaying comments in Class, Interface, Properties Constructor,
2163
- Function and Parameters of constructor or function.
2164
- (Excludes Type alias).
2165
- -->
2166
-
2167
- <div class="code-desc">
2168
- <p><p>Get the metadata associated with the given key for all methods of the
2169
- target class or prototype</p>
2170
- </p>
2171
- <p></p>
2172
- </div>
2173
-
2174
-
2175
-
2176
-
2177
-
2178
-
2179
- <div class="code-arguments-hdr">Arguments</div>
2180
- <table class="params code-arguments">
2181
- <tr>
2182
- <th class="hdr-name">Name</th>
2183
- <th class="hdr-type">Type</th>
2184
- <th class="hdr-desc">Description</th>
2185
- </tr>
2186
-
2187
- <tr class="code-arg">
2188
- <td>
2189
- <strong class="code-arg-name">key</strong>
2190
- </td>
2191
- <td class="code-arg-types">
2192
-
2193
- <code>string</code>
2194
-
2195
-
2196
- </td>
2197
- <td class="code-arg-desc">
2198
- <!--
2199
- Used for displaying comments in Class, Interface, Properties Constructor,
2200
- Function and Parameters of constructor or function.
2201
- (Excludes Type alias).
2202
- -->
2203
-
2204
- <div class="code-desc">
2205
- <p></p>
2206
- <p><p>Metadata key</p>
2207
- </p>
2208
- </div>
2209
-
2210
-
2211
-
2212
-
2213
-
2214
- </td>
2215
- </tr>
2216
-
2217
- <tr class="code-arg">
2218
- <td>
2219
- <strong class="code-arg-name">target</strong>
2220
- </td>
2221
- <td class="code-arg-types">
2222
-
2223
- <code><a href="#Object">Object</a></code>
2224
-
2225
-
2226
- </td>
2227
- <td class="code-arg-desc">
2228
- <!--
2229
- Used for displaying comments in Class, Interface, Properties Constructor,
2230
- Function and Parameters of constructor or function.
2231
- (Excludes Type alias).
2232
- -->
2233
-
2234
- <div class="code-desc">
2235
- <p></p>
2236
- <p><p>Class for static methods or prototype for instance methods</p>
2237
- </p>
2238
- </div>
2239
-
2240
-
2241
-
2242
-
2243
-
2244
- </td>
2245
- </tr>
2246
-
2247
- <tr class="code-arg">
2248
- <td>
2249
- <strong class="code-arg-name">options</strong>
2250
- </td>
2251
- <td class="code-arg-types">
2252
-
2253
- <code><a href="#InspectionOptions">InspectionOptions</a></code>
2254
-
2255
-
2256
- </td>
2257
- <td class="code-arg-desc">
2258
- <!--
2259
- Used for displaying comments in Class, Interface, Properties Constructor,
2260
- Function and Parameters of constructor or function.
2261
- (Excludes Type alias).
2262
- -->
2263
-
2264
- <div class="code-desc">
2265
- <p></p>
2266
- <p><p>Options for inspection</p>
2267
- </p>
2268
- </div>
2269
-
2270
-
2271
-
2272
-
2273
-
2274
- </td>
2275
- </tr>
2276
-
2277
- </table>
2278
-
2279
- </section>
2280
-
2281
-
2282
-
2283
- <section class="code-doc ">
2284
- <a name="153423"></a>
2285
-
2286
- <h4 class="code-ref">getAllParameterMetadata(key: string, target: <a href="#Object">Object</a>, methodName: undefined, options: <a href="#InspectionOptions">InspectionOptions</a>) : undefined | undefined</h4>
2287
-
2288
-
2289
- <!--
2290
- Used for displaying comments in Class, Interface, Properties Constructor,
2291
- Function and Parameters of constructor or function.
2292
- (Excludes Type alias).
2293
- -->
2294
-
2295
- <div class="code-desc">
2296
- <p><p>Get the metadata associated with the given key for all parameters of a
2297
- given method</p>
2298
- </p>
2299
- <p></p>
2300
- </div>
2301
-
2302
-
2303
-
2304
-
2305
-
2306
-
2307
- <div class="code-arguments-hdr">Arguments</div>
2308
- <table class="params code-arguments">
2309
- <tr>
2310
- <th class="hdr-name">Name</th>
2311
- <th class="hdr-type">Type</th>
2312
- <th class="hdr-desc">Description</th>
2313
- </tr>
2314
-
2315
- <tr class="code-arg">
2316
- <td>
2317
- <strong class="code-arg-name">key</strong>
2318
- </td>
2319
- <td class="code-arg-types">
2320
-
2321
- <code>string</code>
2322
-
2323
-
2324
- </td>
2325
- <td class="code-arg-desc">
2326
- <!--
2327
- Used for displaying comments in Class, Interface, Properties Constructor,
2328
- Function and Parameters of constructor or function.
2329
- (Excludes Type alias).
2330
- -->
2331
-
2332
- <div class="code-desc">
2333
- <p></p>
2334
- <p><p>Metadata key</p>
2335
- </p>
2336
- </div>
2337
-
2338
-
2339
-
2340
-
2341
-
2342
- </td>
2343
- </tr>
2344
-
2345
- <tr class="code-arg">
2346
- <td>
2347
- <strong class="code-arg-name">target</strong>
2348
- </td>
2349
- <td class="code-arg-types">
2350
-
2351
- <code><a href="#Object">Object</a></code>
2352
-
2353
-
2354
- </td>
2355
- <td class="code-arg-desc">
2356
- <!--
2357
- Used for displaying comments in Class, Interface, Properties Constructor,
2358
- Function and Parameters of constructor or function.
2359
- (Excludes Type alias).
2360
- -->
2361
-
2362
- <div class="code-desc">
2363
- <p></p>
2364
- <p><p>Class for static methods or prototype for instance methods</p>
2365
- </p>
2366
- </div>
2367
-
2368
-
2369
-
2370
-
2371
-
2372
- </td>
2373
- </tr>
2374
-
2375
- <tr class="code-arg">
2376
- <td>
2377
- <strong class="code-arg-name">methodName</strong>
2378
- </td>
2379
- <td class="code-arg-types">
2380
-
2381
- <code></code>
2382
-
2383
-
2384
- </td>
2385
- <td class="code-arg-desc">
2386
- <!--
2387
- Used for displaying comments in Class, Interface, Properties Constructor,
2388
- Function and Parameters of constructor or function.
2389
- (Excludes Type alias).
2390
- -->
2391
-
2392
- <div class="code-desc">
2393
- <p></p>
2394
- <p><p>Method name. If not present, default to &#39;&#39; to use
2395
- the constructor</p>
2396
- </p>
2397
- </div>
2398
-
2399
-
2400
-
2401
-
2402
-
2403
- </td>
2404
- </tr>
2405
-
2406
- <tr class="code-arg">
2407
- <td>
2408
- <strong class="code-arg-name">options</strong>
2409
- </td>
2410
- <td class="code-arg-types">
2411
-
2412
- <code><a href="#InspectionOptions">InspectionOptions</a></code>
2413
-
2414
-
2415
- </td>
2416
- <td class="code-arg-desc">
2417
- <!--
2418
- Used for displaying comments in Class, Interface, Properties Constructor,
2419
- Function and Parameters of constructor or function.
2420
- (Excludes Type alias).
2421
- -->
2422
-
2423
- <div class="code-desc">
2424
- <p></p>
2425
- <p><p>Options for inspection</p>
2426
- </p>
2427
- </div>
2428
-
2429
-
2430
-
2431
-
2432
-
2433
- </td>
2434
- </tr>
2435
-
2436
- </table>
2437
-
2438
- </section>
2439
-
2440
-
2441
-
2442
- <section class="code-doc ">
2443
- <a name="153410"></a>
2444
-
2445
- <h4 class="code-ref">getAllPropertyMetadata(key: string, target: <a href="#Object">Object</a>, options: <a href="#InspectionOptions">InspectionOptions</a>) : <a href="#MetadataMap">MetadataMap</a> | undefined</h4>
2446
-
2447
-
2448
- <!--
2449
- Used for displaying comments in Class, Interface, Properties Constructor,
2450
- Function and Parameters of constructor or function.
2451
- (Excludes Type alias).
2452
- -->
2453
-
2454
- <div class="code-desc">
2455
- <p><p>Get the metadata associated with the given key for all properties of the
2456
- target class or prototype</p>
2457
- </p>
2458
- <p></p>
2459
- </div>
2460
-
2461
-
2462
-
2463
-
2464
-
2465
-
2466
- <div class="code-arguments-hdr">Arguments</div>
2467
- <table class="params code-arguments">
2468
- <tr>
2469
- <th class="hdr-name">Name</th>
2470
- <th class="hdr-type">Type</th>
2471
- <th class="hdr-desc">Description</th>
2472
- </tr>
2473
-
2474
- <tr class="code-arg">
2475
- <td>
2476
- <strong class="code-arg-name">key</strong>
2477
- </td>
2478
- <td class="code-arg-types">
2479
-
2480
- <code>string</code>
2481
-
2482
-
2483
- </td>
2484
- <td class="code-arg-desc">
2485
- <!--
2486
- Used for displaying comments in Class, Interface, Properties Constructor,
2487
- Function and Parameters of constructor or function.
2488
- (Excludes Type alias).
2489
- -->
2490
-
2491
- <div class="code-desc">
2492
- <p></p>
2493
- <p><p>Metadata key</p>
2494
- </p>
2495
- </div>
2496
-
2497
-
2498
-
2499
-
2500
-
2501
- </td>
2502
- </tr>
2503
-
2504
- <tr class="code-arg">
2505
- <td>
2506
- <strong class="code-arg-name">target</strong>
2507
- </td>
2508
- <td class="code-arg-types">
2509
-
2510
- <code><a href="#Object">Object</a></code>
2511
-
2512
-
2513
- </td>
2514
- <td class="code-arg-desc">
2515
- <!--
2516
- Used for displaying comments in Class, Interface, Properties Constructor,
2517
- Function and Parameters of constructor or function.
2518
- (Excludes Type alias).
2519
- -->
2520
-
2521
- <div class="code-desc">
2522
- <p></p>
2523
- <p><p>Class for static methods or prototype for instance methods</p>
2524
- </p>
2525
- </div>
2526
-
2527
-
2528
-
2529
-
2530
-
2531
- </td>
2532
- </tr>
2533
-
2534
- <tr class="code-arg">
2535
- <td>
2536
- <strong class="code-arg-name">options</strong>
2537
- </td>
2538
- <td class="code-arg-types">
2539
-
2540
- <code><a href="#InspectionOptions">InspectionOptions</a></code>
2541
-
2542
-
2543
- </td>
2544
- <td class="code-arg-desc">
2545
- <!--
2546
- Used for displaying comments in Class, Interface, Properties Constructor,
2547
- Function and Parameters of constructor or function.
2548
- (Excludes Type alias).
2549
- -->
2550
-
2551
- <div class="code-desc">
2552
- <p></p>
2553
- <p><p>Options for inspection</p>
2554
- </p>
2555
- </div>
2556
-
2557
-
2558
-
2559
-
2560
-
2561
- </td>
2562
- </tr>
2563
-
2564
- </table>
2565
-
2566
- </section>
2567
-
2568
-
2569
-
2570
- <section class="code-doc ">
2571
- <a name="153384"></a>
2572
-
2573
- <h4 class="code-ref">getClassMetadata(key: string, target: <a href="#Function">Function</a>, options: <a href="#InspectionOptions">InspectionOptions</a>) : T | undefined</h4>
2574
-
2575
-
2576
- <!--
2577
- Used for displaying comments in Class, Interface, Properties Constructor,
2578
- Function and Parameters of constructor or function.
2579
- (Excludes Type alias).
2580
- -->
2581
-
2582
- <div class="code-desc">
2583
- <p><p>Get the metadata associated with the given key for a given class</p>
2584
- </p>
2585
- <p></p>
2586
- </div>
2587
-
2588
-
2589
-
2590
-
2591
-
2592
-
2593
- <div class="code-arguments-hdr">Arguments</div>
2594
- <table class="params code-arguments">
2595
- <tr>
2596
- <th class="hdr-name">Name</th>
2597
- <th class="hdr-type">Type</th>
2598
- <th class="hdr-desc">Description</th>
2599
- </tr>
2600
-
2601
- <tr class="code-arg">
2602
- <td>
2603
- <strong class="code-arg-name">key</strong>
2604
- </td>
2605
- <td class="code-arg-types">
2606
-
2607
- <code>string</code>
2608
-
2609
-
2610
- </td>
2611
- <td class="code-arg-desc">
2612
- <!--
2613
- Used for displaying comments in Class, Interface, Properties Constructor,
2614
- Function and Parameters of constructor or function.
2615
- (Excludes Type alias).
2616
- -->
2617
-
2618
- <div class="code-desc">
2619
- <p></p>
2620
- <p><p>Metadata key</p>
2621
- </p>
2622
- </div>
2623
-
2624
-
2625
-
2626
-
2627
-
2628
- </td>
2629
- </tr>
2630
-
2631
- <tr class="code-arg">
2632
- <td>
2633
- <strong class="code-arg-name">target</strong>
2634
- </td>
2635
- <td class="code-arg-types">
2636
-
2637
- <code><a href="#Function">Function</a></code>
2638
-
2639
-
2640
- </td>
2641
- <td class="code-arg-desc">
2642
- <!--
2643
- Used for displaying comments in Class, Interface, Properties Constructor,
2644
- Function and Parameters of constructor or function.
2645
- (Excludes Type alias).
2646
- -->
2647
-
2648
- <div class="code-desc">
2649
- <p></p>
2650
- <p><p>Class that contains the metadata</p>
2651
- </p>
2652
- </div>
2653
-
2654
-
2655
-
2656
-
2657
-
2658
- </td>
2659
- </tr>
2660
-
2661
- <tr class="code-arg">
2662
- <td>
2663
- <strong class="code-arg-name">options</strong>
2664
- </td>
2665
- <td class="code-arg-types">
2666
-
2667
- <code><a href="#InspectionOptions">InspectionOptions</a></code>
2668
-
2669
-
2670
- </td>
2671
- <td class="code-arg-desc">
2672
- <!--
2673
- Used for displaying comments in Class, Interface, Properties Constructor,
2674
- Function and Parameters of constructor or function.
2675
- (Excludes Type alias).
2676
- -->
2677
-
2678
- <div class="code-desc">
2679
- <p></p>
2680
- <p><p>Options for inspection</p>
2681
- </p>
2682
- </div>
2683
-
2684
-
2685
-
2686
-
2687
-
2688
- </td>
2689
- </tr>
2690
-
2691
- </table>
2692
-
2693
- </section>
2694
-
2695
-
2696
-
2697
- <section class="code-doc ">
2698
- <a name="153442"></a>
2699
-
2700
- <h4 class="code-ref">getDesignTypeForMethod(target: <a href="#Object">Object</a>, methodName: undefined) : DesignTimeMethodMetadata</h4>
2701
-
2702
-
2703
- <!--
2704
- Used for displaying comments in Class, Interface, Properties Constructor,
2705
- Function and Parameters of constructor or function.
2706
- (Excludes Type alias).
2707
- -->
2708
-
2709
- <div class="code-desc">
2710
- <p><p>Get TypeScript design time type for a method</p>
2711
- </p>
2712
- <p></p>
2713
- </div>
2714
-
2715
-
2716
-
2717
-
2718
-
2719
-
2720
- <div class="code-arguments-hdr">Arguments</div>
2721
- <table class="params code-arguments">
2722
- <tr>
2723
- <th class="hdr-name">Name</th>
2724
- <th class="hdr-type">Type</th>
2725
- <th class="hdr-desc">Description</th>
2726
- </tr>
2727
-
2728
- <tr class="code-arg">
2729
- <td>
2730
- <strong class="code-arg-name">target</strong>
2731
- </td>
2732
- <td class="code-arg-types">
2733
-
2734
- <code><a href="#Object">Object</a></code>
2735
-
2736
-
2737
- </td>
2738
- <td class="code-arg-desc">
2739
- <!--
2740
- Used for displaying comments in Class, Interface, Properties Constructor,
2741
- Function and Parameters of constructor or function.
2742
- (Excludes Type alias).
2743
- -->
2744
-
2745
- <div class="code-desc">
2746
- <p></p>
2747
- <p><p>Class or prototype</p>
2748
- </p>
2749
- </div>
2750
-
2751
-
2752
-
2753
-
2754
-
2755
- </td>
2756
- </tr>
2757
-
2758
- <tr class="code-arg">
2759
- <td>
2760
- <strong class="code-arg-name">methodName</strong>
2761
- </td>
2762
- <td class="code-arg-types">
2763
-
2764
- <code></code>
2765
-
2766
-
2767
- </td>
2768
- <td class="code-arg-desc">
2769
- <!--
2770
- Used for displaying comments in Class, Interface, Properties Constructor,
2771
- Function and Parameters of constructor or function.
2772
- (Excludes Type alias).
2773
- -->
2774
-
2775
- <div class="code-desc">
2776
- <p></p>
2777
- <p><p>Method name</p>
2778
- </p>
2779
- </div>
2780
-
2781
-
2782
-
2783
-
2784
-
2785
- </td>
2786
- </tr>
2787
-
2788
- </table>
2789
-
2790
- </section>
2791
-
2792
-
2793
-
2794
- <section class="code-doc ">
2795
- <a name="153438"></a>
2796
-
2797
- <h4 class="code-ref">getDesignTypeForProperty(target: <a href="#Object">Object</a>, propertyName: undefined) : Function</h4>
2798
-
2799
-
2800
- <!--
2801
- Used for displaying comments in Class, Interface, Properties Constructor,
2802
- Function and Parameters of constructor or function.
2803
- (Excludes Type alias).
2804
- -->
2805
-
2806
- <div class="code-desc">
2807
- <p><p>Get TypeScript design time type for a property</p>
2808
- </p>
2809
- <p></p>
2810
- </div>
2811
-
2812
-
2813
-
2814
-
2815
-
2816
-
2817
- <div class="code-arguments-hdr">Arguments</div>
2818
- <table class="params code-arguments">
2819
- <tr>
2820
- <th class="hdr-name">Name</th>
2821
- <th class="hdr-type">Type</th>
2822
- <th class="hdr-desc">Description</th>
2823
- </tr>
2824
-
2825
- <tr class="code-arg">
2826
- <td>
2827
- <strong class="code-arg-name">target</strong>
2828
- </td>
2829
- <td class="code-arg-types">
2830
-
2831
- <code><a href="#Object">Object</a></code>
2832
-
2833
-
2834
- </td>
2835
- <td class="code-arg-desc">
2836
- <!--
2837
- Used for displaying comments in Class, Interface, Properties Constructor,
2838
- Function and Parameters of constructor or function.
2839
- (Excludes Type alias).
2840
- -->
2841
-
2842
- <div class="code-desc">
2843
- <p></p>
2844
- <p><p>Class or prototype</p>
2845
- </p>
2846
- </div>
2847
-
2848
-
2849
-
2850
-
2851
-
2852
- </td>
2853
- </tr>
2854
-
2855
- <tr class="code-arg">
2856
- <td>
2857
- <strong class="code-arg-name">propertyName</strong>
2858
- </td>
2859
- <td class="code-arg-types">
2860
-
2861
- <code></code>
2862
-
2863
-
2864
- </td>
2865
- <td class="code-arg-desc">
2866
- <!--
2867
- Used for displaying comments in Class, Interface, Properties Constructor,
2868
- Function and Parameters of constructor or function.
2869
- (Excludes Type alias).
2870
- -->
2871
-
2872
- <div class="code-desc">
2873
- <p></p>
2874
- <p><p>Property name</p>
2875
- </p>
2876
- </div>
2877
-
2878
-
2879
-
2880
-
2881
-
2882
- </td>
2883
- </tr>
2884
-
2885
- </table>
2886
-
2887
- </section>
2888
-
2889
-
2890
-
2891
- <section class="code-doc ">
2892
- <a name="153403"></a>
2893
-
2894
- <h4 class="code-ref">getMethodMetadata(key: string, target: <a href="#Object">Object</a>, methodName: undefined, options: <a href="#InspectionOptions">InspectionOptions</a>) : T | undefined</h4>
2895
-
2896
-
2897
- <!--
2898
- Used for displaying comments in Class, Interface, Properties Constructor,
2899
- Function and Parameters of constructor or function.
2900
- (Excludes Type alias).
2901
- -->
2902
-
2903
- <div class="code-desc">
2904
- <p><p>Get the metadata associated with the given key for a given method of the
2905
- target class or prototype</p>
2906
- </p>
2907
- <p></p>
2908
- </div>
2909
-
2910
-
2911
-
2912
-
2913
-
2914
-
2915
- <div class="code-arguments-hdr">Arguments</div>
2916
- <table class="params code-arguments">
2917
- <tr>
2918
- <th class="hdr-name">Name</th>
2919
- <th class="hdr-type">Type</th>
2920
- <th class="hdr-desc">Description</th>
2921
- </tr>
2922
-
2923
- <tr class="code-arg">
2924
- <td>
2925
- <strong class="code-arg-name">key</strong>
2926
- </td>
2927
- <td class="code-arg-types">
2928
-
2929
- <code>string</code>
2930
-
2931
-
2932
- </td>
2933
- <td class="code-arg-desc">
2934
- <!--
2935
- Used for displaying comments in Class, Interface, Properties Constructor,
2936
- Function and Parameters of constructor or function.
2937
- (Excludes Type alias).
2938
- -->
2939
-
2940
- <div class="code-desc">
2941
- <p></p>
2942
- <p><p>Metadata key</p>
2943
- </p>
2944
- </div>
2945
-
2946
-
2947
-
2948
-
2949
-
2950
- </td>
2951
- </tr>
2952
-
2953
- <tr class="code-arg">
2954
- <td>
2955
- <strong class="code-arg-name">target</strong>
2956
- </td>
2957
- <td class="code-arg-types">
2958
-
2959
- <code><a href="#Object">Object</a></code>
2960
-
2961
-
2962
- </td>
2963
- <td class="code-arg-desc">
2964
- <!--
2965
- Used for displaying comments in Class, Interface, Properties Constructor,
2966
- Function and Parameters of constructor or function.
2967
- (Excludes Type alias).
2968
- -->
2969
-
2970
- <div class="code-desc">
2971
- <p></p>
2972
- <p><p>Class for static methods or prototype for instance methods</p>
2973
- </p>
2974
- </div>
2975
-
2976
-
2977
-
2978
-
2979
-
2980
- </td>
2981
- </tr>
2982
-
2983
- <tr class="code-arg">
2984
- <td>
2985
- <strong class="code-arg-name">methodName</strong>
2986
- </td>
2987
- <td class="code-arg-types">
2988
-
2989
- <code></code>
2990
-
2991
-
2992
- </td>
2993
- <td class="code-arg-desc">
2994
- <!--
2995
- Used for displaying comments in Class, Interface, Properties Constructor,
2996
- Function and Parameters of constructor or function.
2997
- (Excludes Type alias).
2998
- -->
2999
-
3000
- <div class="code-desc">
3001
- <p></p>
3002
- <p><p>Method name. If not present, default to &#39;&#39; to use
3003
- the constructor</p>
3004
- </p>
3005
- </div>
3006
-
3007
-
3008
-
3009
-
3010
-
3011
- </td>
3012
- </tr>
3013
-
3014
- <tr class="code-arg">
3015
- <td>
3016
- <strong class="code-arg-name">options</strong>
3017
- </td>
3018
- <td class="code-arg-types">
3019
-
3020
- <code><a href="#InspectionOptions">InspectionOptions</a></code>
3021
-
3022
-
3023
- </td>
3024
- <td class="code-arg-desc">
3025
- <!--
3026
- Used for displaying comments in Class, Interface, Properties Constructor,
3027
- Function and Parameters of constructor or function.
3028
- (Excludes Type alias).
3029
- -->
3030
-
3031
- <div class="code-desc">
3032
- <p></p>
3033
- <p><p>Options for inspection</p>
3034
- </p>
3035
- </div>
3036
-
3037
-
3038
-
3039
-
3040
-
3041
- </td>
3042
- </tr>
3043
-
3044
- </table>
3045
-
3046
- </section>
3047
-
3048
-
3049
-
3050
- <section class="code-doc ">
3051
- <a name="153430"></a>
3052
-
3053
- <h4 class="code-ref">getParameterMetadata(key: string, target: <a href="#Object">Object</a>, methodName: undefined, index: number, options: <a href="#InspectionOptions">InspectionOptions</a>) : T | undefined</h4>
3054
-
3055
-
3056
- <!--
3057
- Used for displaying comments in Class, Interface, Properties Constructor,
3058
- Function and Parameters of constructor or function.
3059
- (Excludes Type alias).
3060
- -->
3061
-
3062
- <div class="code-desc">
3063
- <p><p>Get the metadata associated with the given key for a parameter of a given
3064
- method by index</p>
3065
- </p>
3066
- <p></p>
3067
- </div>
3068
-
3069
-
3070
-
3071
-
3072
-
3073
-
3074
- <div class="code-arguments-hdr">Arguments</div>
3075
- <table class="params code-arguments">
3076
- <tr>
3077
- <th class="hdr-name">Name</th>
3078
- <th class="hdr-type">Type</th>
3079
- <th class="hdr-desc">Description</th>
3080
- </tr>
3081
-
3082
- <tr class="code-arg">
3083
- <td>
3084
- <strong class="code-arg-name">key</strong>
3085
- </td>
3086
- <td class="code-arg-types">
3087
-
3088
- <code>string</code>
3089
-
3090
-
3091
- </td>
3092
- <td class="code-arg-desc">
3093
- <!--
3094
- Used for displaying comments in Class, Interface, Properties Constructor,
3095
- Function and Parameters of constructor or function.
3096
- (Excludes Type alias).
3097
- -->
3098
-
3099
- <div class="code-desc">
3100
- <p></p>
3101
- <p><p>Metadata key</p>
3102
- </p>
3103
- </div>
3104
-
3105
-
3106
-
3107
-
3108
-
3109
- </td>
3110
- </tr>
3111
-
3112
- <tr class="code-arg">
3113
- <td>
3114
- <strong class="code-arg-name">target</strong>
3115
- </td>
3116
- <td class="code-arg-types">
3117
-
3118
- <code><a href="#Object">Object</a></code>
3119
-
3120
-
3121
- </td>
3122
- <td class="code-arg-desc">
3123
- <!--
3124
- Used for displaying comments in Class, Interface, Properties Constructor,
3125
- Function and Parameters of constructor or function.
3126
- (Excludes Type alias).
3127
- -->
3128
-
3129
- <div class="code-desc">
3130
- <p></p>
3131
- <p><p>Class for static methods or prototype for instance methods</p>
3132
- </p>
3133
- </div>
3134
-
3135
-
3136
-
3137
-
3138
-
3139
- </td>
3140
- </tr>
3141
-
3142
- <tr class="code-arg">
3143
- <td>
3144
- <strong class="code-arg-name">methodName</strong>
3145
- </td>
3146
- <td class="code-arg-types">
3147
-
3148
- <code></code>
3149
-
3150
-
3151
- </td>
3152
- <td class="code-arg-desc">
3153
- <!--
3154
- Used for displaying comments in Class, Interface, Properties Constructor,
3155
- Function and Parameters of constructor or function.
3156
- (Excludes Type alias).
3157
- -->
3158
-
3159
- <div class="code-desc">
3160
- <p></p>
3161
- <p><p>Method name. If not present, default to &#39;&#39; to use
3162
- the constructor</p>
3163
- </p>
3164
- </div>
3165
-
3166
-
3167
-
3168
-
3169
-
3170
- </td>
3171
- </tr>
3172
-
3173
- <tr class="code-arg">
3174
- <td>
3175
- <strong class="code-arg-name">index</strong>
3176
- </td>
3177
- <td class="code-arg-types">
3178
-
3179
- <code>number</code>
3180
-
3181
-
3182
- </td>
3183
- <td class="code-arg-desc">
3184
- <!--
3185
- Used for displaying comments in Class, Interface, Properties Constructor,
3186
- Function and Parameters of constructor or function.
3187
- (Excludes Type alias).
3188
- -->
3189
-
3190
- <div class="code-desc">
3191
- <p></p>
3192
- <p><p>Index of the parameter, starting with 0</p>
3193
- </p>
3194
- </div>
3195
-
3196
-
3197
-
3198
-
3199
-
3200
- </td>
3201
- </tr>
3202
-
3203
- <tr class="code-arg">
3204
- <td>
3205
- <strong class="code-arg-name">options</strong>
3206
- </td>
3207
- <td class="code-arg-types">
3208
-
3209
- <code><a href="#InspectionOptions">InspectionOptions</a></code>
3210
-
3211
-
3212
- </td>
3213
- <td class="code-arg-desc">
3214
- <!--
3215
- Used for displaying comments in Class, Interface, Properties Constructor,
3216
- Function and Parameters of constructor or function.
3217
- (Excludes Type alias).
3218
- -->
3219
-
3220
- <div class="code-desc">
3221
- <p></p>
3222
- <p><p>Options for inspection</p>
3223
- </p>
3224
- </div>
3225
-
3226
-
3227
-
3228
-
3229
-
3230
- </td>
3231
- </tr>
3232
-
3233
- </table>
3234
-
3235
- </section>
3236
-
3237
-
3238
-
3239
- <section class="code-doc ">
3240
- <a name="153416"></a>
3241
-
3242
- <h4 class="code-ref">getPropertyMetadata(key: string, target: <a href="#Object">Object</a>, propertyName: undefined, options: <a href="#InspectionOptions">InspectionOptions</a>) : T | undefined</h4>
3243
-
3244
-
3245
- <!--
3246
- Used for displaying comments in Class, Interface, Properties Constructor,
3247
- Function and Parameters of constructor or function.
3248
- (Excludes Type alias).
3249
- -->
3250
-
3251
- <div class="code-desc">
3252
- <p><p>Get the metadata associated with the given key for a given property of the
3253
- target class or prototype</p>
3254
- </p>
3255
- <p></p>
3256
- </div>
3257
-
3258
-
3259
-
3260
-
3261
-
3262
-
3263
- <div class="code-arguments-hdr">Arguments</div>
3264
- <table class="params code-arguments">
3265
- <tr>
3266
- <th class="hdr-name">Name</th>
3267
- <th class="hdr-type">Type</th>
3268
- <th class="hdr-desc">Description</th>
3269
- </tr>
3270
-
3271
- <tr class="code-arg">
3272
- <td>
3273
- <strong class="code-arg-name">key</strong>
3274
- </td>
3275
- <td class="code-arg-types">
3276
-
3277
- <code>string</code>
3278
-
3279
-
3280
- </td>
3281
- <td class="code-arg-desc">
3282
- <!--
3283
- Used for displaying comments in Class, Interface, Properties Constructor,
3284
- Function and Parameters of constructor or function.
3285
- (Excludes Type alias).
3286
- -->
3287
-
3288
- <div class="code-desc">
3289
- <p></p>
3290
- <p><p>Metadata key</p>
3291
- </p>
3292
- </div>
3293
-
3294
-
3295
-
3296
-
3297
-
3298
- </td>
3299
- </tr>
3300
-
3301
- <tr class="code-arg">
3302
- <td>
3303
- <strong class="code-arg-name">target</strong>
3304
- </td>
3305
- <td class="code-arg-types">
3306
-
3307
- <code><a href="#Object">Object</a></code>
3308
-
3309
-
3310
- </td>
3311
- <td class="code-arg-desc">
3312
- <!--
3313
- Used for displaying comments in Class, Interface, Properties Constructor,
3314
- Function and Parameters of constructor or function.
3315
- (Excludes Type alias).
3316
- -->
3317
-
3318
- <div class="code-desc">
3319
- <p></p>
3320
- <p><p>Class for static properties or prototype for instance
3321
- properties</p>
3322
- </p>
3323
- </div>
3324
-
3325
-
3326
-
3327
-
3328
-
3329
- </td>
3330
- </tr>
3331
-
3332
- <tr class="code-arg">
3333
- <td>
3334
- <strong class="code-arg-name">propertyName</strong>
3335
- </td>
3336
- <td class="code-arg-types">
3337
-
3338
- <code></code>
3339
-
3340
-
3341
- </td>
3342
- <td class="code-arg-desc">
3343
- <!--
3344
- Used for displaying comments in Class, Interface, Properties Constructor,
3345
- Function and Parameters of constructor or function.
3346
- (Excludes Type alias).
3347
- -->
3348
-
3349
- <div class="code-desc">
3350
- <p></p>
3351
- <p><p>Property name</p>
3352
- </p>
3353
- </div>
3354
-
3355
-
3356
-
3357
-
3358
-
3359
- </td>
3360
- </tr>
3361
-
3362
- <tr class="code-arg">
3363
- <td>
3364
- <strong class="code-arg-name">options</strong>
3365
- </td>
3366
- <td class="code-arg-types">
3367
-
3368
- <code><a href="#InspectionOptions">InspectionOptions</a></code>
3369
-
3370
-
3371
- </td>
3372
- <td class="code-arg-desc">
3373
- <!--
3374
- Used for displaying comments in Class, Interface, Properties Constructor,
3375
- Function and Parameters of constructor or function.
3376
- (Excludes Type alias).
3377
- -->
3378
-
3379
- <div class="code-desc">
3380
- <p></p>
3381
- <p><p>Options for inspection</p>
3382
- </p>
3383
- </div>
3384
-
3385
-
3386
-
3387
-
3388
-
3389
- </td>
3390
- </tr>
3391
-
3392
- </table>
3393
-
3394
- </section>
3395
-
3396
-
3397
-
3398
- <section class="code-doc ">
3399
- <a name="DesignTimeMethodMetadata"></a>
3400
- <h3 class="code-ref">Interface: DesignTimeMethodMetadata</h3>
3401
- <!--
3402
- Used for displaying comments in Class, Interface, Properties Constructor,
3403
- Function and Parameters of constructor or function.
3404
- (Excludes Type alias).
3405
- -->
3406
-
3407
- <div class="code-desc">
3408
- <p><p>Design time metadata for a method.</p>
3409
- </p>
3410
- <p></p>
3411
- </div>
3412
-
3413
-
3414
-
3415
-
3416
-
3417
- </section>
3418
-
3419
- <section class="code-doc">
3420
- <a name="TODO"></a>
3421
- <div class="code-arguments-hdr">Properties</div>
3422
- <table class="params code-arguments">
3423
- <tr>
3424
- <th class="hdr-name">Name</th>
3425
- <th class="hdr-type">Type</th>
3426
- <th class="hdr-desc">Description</th>
3427
- </tr>
3428
-
3429
- <tr class="code-arg">
3430
- <td>
3431
- <a name="DesignTimeMethodMetadata"></a>
3432
- <strong class="code-arg-name">parameterTypes</strong>
3433
- </td>
3434
- <td class="code-arg-types">
3435
-
3436
- <code></code>
3437
-
3438
-
3439
- </td>
3440
- <td class="code-arg-desc">
3441
- <!--
3442
- Used for displaying comments in Class, Interface, Properties Constructor,
3443
- Function and Parameters of constructor or function.
3444
- (Excludes Type alias).
3445
- -->
3446
-
3447
- <div class="code-desc">
3448
- <p><p>An array of parameter types</p>
3449
- </p>
3450
- <p></p>
3451
- </div>
3452
-
3453
-
3454
-
3455
-
3456
-
3457
- </td>
3458
- </tr>
3459
-
3460
- <tr class="code-arg">
3461
- <td>
3462
- <a name="DesignTimeMethodMetadata"></a>
3463
- <strong class="code-arg-name">returnType</strong>
3464
- </td>
3465
- <td class="code-arg-types">
3466
-
3467
- <code><a href="#Function">Function</a></code>
3468
-
3469
-
3470
- </td>
3471
- <td class="code-arg-desc">
3472
- <!--
3473
- Used for displaying comments in Class, Interface, Properties Constructor,
3474
- Function and Parameters of constructor or function.
3475
- (Excludes Type alias).
3476
- -->
3477
-
3478
- <div class="code-desc">
3479
- <p><p>Return type</p>
3480
- </p>
3481
- <p></p>
3482
- </div>
3483
-
3484
-
3485
-
3486
-
3487
-
3488
- </td>
3489
- </tr>
3490
-
3491
- <tr class="code-arg">
3492
- <td>
3493
- <a name="DesignTimeMethodMetadata"></a>
3494
- <strong class="code-arg-name">type</strong>
3495
- </td>
3496
- <td class="code-arg-types">
3497
-
3498
- <code><a href="#Function">Function</a></code>
3499
-
3500
-
3501
- </td>
3502
- <td class="code-arg-desc">
3503
- <!--
3504
- Used for displaying comments in Class, Interface, Properties Constructor,
3505
- Function and Parameters of constructor or function.
3506
- (Excludes Type alias).
3507
- -->
3508
-
3509
- <div class="code-desc">
3510
- <p><p>Type of the method itself. It is <code>Function</code></p>
3511
- </p>
3512
- <p></p>
3513
- </div>
3514
-
3515
-
3516
-
3517
-
3518
-
3519
- </td>
3520
- </tr>
3521
-
3522
- </table>
3523
- </section>
3524
-
3525
-
3526
- <section class="code-doc ">
3527
- <a name="InspectionOptions"></a>
3528
- <h3 class="code-ref">Interface: InspectionOptions</h3>
3529
- <!--
3530
- Used for displaying comments in Class, Interface, Properties Constructor,
3531
- Function and Parameters of constructor or function.
3532
- (Excludes Type alias).
3533
- -->
3534
-
3535
- <div class="code-desc">
3536
- <p><p>Options for inspection</p>
3537
- </p>
3538
- <p></p>
3539
- </div>
3540
-
3541
-
3542
-
3543
-
3544
-
3545
- </section>
3546
-
3547
- <section class="code-doc">
3548
- <a name="TODO"></a>
3549
- <div class="code-arguments-hdr">Properties</div>
3550
- <table class="params code-arguments">
3551
- <tr>
3552
- <th class="hdr-name">Name</th>
3553
- <th class="hdr-type">Type</th>
3554
- <th class="hdr-desc">Description</th>
3555
- </tr>
3556
-
3557
- <tr class="code-arg">
3558
- <td>
3559
- <a name="InspectionOptions"></a>
3560
- <strong class="code-arg-name">ownMetadataOnly</strong>
3561
- </td>
3562
- <td class="code-arg-types">
3563
-
3564
- <code></code>
3565
-
3566
-
3567
- </td>
3568
- <td class="code-arg-desc">
3569
- <!--
3570
- Used for displaying comments in Class, Interface, Properties Constructor,
3571
- Function and Parameters of constructor or function.
3572
- (Excludes Type alias).
3573
- -->
3574
-
3575
- <div class="code-desc">
3576
- <p><p>Only inspect own metadata of a given target. The prototype chain will not
3577
- be checked. The implementation uses <code>Reflect.getOwnMetadata()</code> if the flag
3578
- is set to <code>true</code>. Otherwise, it uses <code>Reflect.getMetadata()</code>.</p>
3579
- </p>
3580
- <p><p>The flag is <code>false</code> by default for <code>MetadataInspector</code>.</p>
3581
- </p>
3582
- </div>
3583
-
3584
-
3585
-
3586
-
3587
-
3588
- </td>
3589
- </tr>
3590
-
3591
- </table>
3592
- </section>
3593
-
3594
-
3595
- <section class="code-doc ">
3596
- <a name="NamespacedReflect"></a>
3597
- <h3 class="code-ref">Class: namespacedreflect = new NamespacedReflect()</h3>
3598
- <!--
3599
- Used for displaying comments in Class, Interface, Properties Constructor,
3600
- Function and Parameters of constructor or function.
3601
- (Excludes Type alias).
3602
- -->
3603
-
3604
-
3605
-
3606
-
3607
-
3608
- </section>
3609
-
3610
- <section class="code-doc ">
3611
- <a name="132417"></a>
3612
-
3613
- <h4 class="code-ref">constructor(namespace: undefined) : NamespacedReflect</h4>
3614
-
3615
-
3616
- <!--
3617
- Used for displaying comments in Class, Interface, Properties Constructor,
3618
- Function and Parameters of constructor or function.
3619
- (Excludes Type alias).
3620
- -->
3621
-
3622
- <div class="code-desc">
3623
- <p></p>
3624
- <p></p>
3625
- </div>
3626
-
3627
-
3628
-
3629
-
3630
-
3631
-
3632
- <div class="code-arguments-hdr">Arguments</div>
3633
- <table class="params code-arguments">
3634
- <tr>
3635
- <th class="hdr-name">Name</th>
3636
- <th class="hdr-type">Type</th>
3637
- <th class="hdr-desc">Description</th>
3638
- </tr>
3639
-
3640
- <tr class="code-arg">
3641
- <td>
3642
- <strong class="code-arg-name">namespace</strong>
3643
- </td>
3644
- <td class="code-arg-types">
3645
-
3646
- <code></code>
3647
-
3648
-
3649
- </td>
3650
- <td class="code-arg-desc">
3651
- <!--
3652
- Used for displaying comments in Class, Interface, Properties Constructor,
3653
- Function and Parameters of constructor or function.
3654
- (Excludes Type alias).
3655
- -->
3656
-
3657
- <div class="code-desc">
3658
- <p><p>: namespace to bind this reflect context</p>
3659
- </p>
3660
- <p></p>
3661
- </div>
3662
-
3663
-
3664
-
3665
-
3666
-
3667
- </td>
3668
- </tr>
3669
-
3670
- </table>
3671
-
3672
- </section>
3673
-
3674
-
3675
- <section class="code-doc ">
3676
- <a name="132463"></a>
3677
-
3678
- <h4 class="code-ref">decorate(decorators: undefined, target: <a href="#Object">Object</a>, targetKey: undefined, descriptor: <a href="#PropertyDescriptor">PropertyDescriptor</a>) : <a href="#PropertyDescriptor">PropertyDescriptor</a> | <a href="#Function">Function</a></h4>
3679
-
3680
-
3681
- <!--
3682
- Used for displaying comments in Class, Interface, Properties Constructor,
3683
- Function and Parameters of constructor or function.
3684
- (Excludes Type alias).
3685
- -->
3686
-
3687
-
3688
-
3689
-
3690
-
3691
-
3692
- <div class="code-arguments-hdr">Arguments</div>
3693
- <table class="params code-arguments">
3694
- <tr>
3695
- <th class="hdr-name">Name</th>
3696
- <th class="hdr-type">Type</th>
3697
- <th class="hdr-desc">Description</th>
3698
- </tr>
3699
-
3700
- <tr class="code-arg">
3701
- <td>
3702
- <strong class="code-arg-name">decorators</strong>
3703
- </td>
3704
- <td class="code-arg-types">
3705
-
3706
- <code></code>
3707
-
3708
-
3709
- </td>
3710
- <td class="code-arg-desc">
3711
- <!--
3712
- Used for displaying comments in Class, Interface, Properties Constructor,
3713
- Function and Parameters of constructor or function.
3714
- (Excludes Type alias).
3715
- -->
3716
-
3717
-
3718
-
3719
-
3720
-
3721
- </td>
3722
- </tr>
3723
-
3724
- <tr class="code-arg">
3725
- <td>
3726
- <strong class="code-arg-name">target</strong>
3727
- </td>
3728
- <td class="code-arg-types">
3729
-
3730
- <code><a href="#Object">Object</a></code>
3731
-
3732
-
3733
- </td>
3734
- <td class="code-arg-desc">
3735
- <!--
3736
- Used for displaying comments in Class, Interface, Properties Constructor,
3737
- Function and Parameters of constructor or function.
3738
- (Excludes Type alias).
3739
- -->
3740
-
3741
-
3742
-
3743
-
3744
-
3745
- </td>
3746
- </tr>
3747
-
3748
- <tr class="code-arg">
3749
- <td>
3750
- <strong class="code-arg-name">targetKey</strong>
3751
- </td>
3752
- <td class="code-arg-types">
3753
-
3754
- <code></code>
3755
-
3756
-
3757
- </td>
3758
- <td class="code-arg-desc">
3759
- <!--
3760
- Used for displaying comments in Class, Interface, Properties Constructor,
3761
- Function and Parameters of constructor or function.
3762
- (Excludes Type alias).
3763
- -->
3764
-
3765
-
3766
-
3767
-
3768
-
3769
- </td>
3770
- </tr>
3771
-
3772
- <tr class="code-arg">
3773
- <td>
3774
- <strong class="code-arg-name">descriptor</strong>
3775
- </td>
3776
- <td class="code-arg-types">
3777
-
3778
- <code><a href="#PropertyDescriptor">PropertyDescriptor</a></code>
3779
-
3780
-
3781
- </td>
3782
- <td class="code-arg-desc">
3783
- <!--
3784
- Used for displaying comments in Class, Interface, Properties Constructor,
3785
- Function and Parameters of constructor or function.
3786
- (Excludes Type alias).
3787
- -->
3788
-
3789
-
3790
-
3791
-
3792
-
3793
- </td>
3794
- </tr>
3795
-
3796
- </table>
3797
-
3798
- </section>
3799
-
3800
-
3801
-
3802
- <section class="code-doc ">
3803
- <a name="132424"></a>
3804
-
3805
- <h4 class="code-ref">defineMetadata(metadataKey: string, metadataValue: any, target: <a href="#Object">Object</a>, propertyKey: undefined) : void</h4>
3806
-
3807
-
3808
- <!--
3809
- Used for displaying comments in Class, Interface, Properties Constructor,
3810
- Function and Parameters of constructor or function.
3811
- (Excludes Type alias).
3812
- -->
3813
-
3814
- <div class="code-desc">
3815
- <p><p>define metadata for a target class or it&#39;s property/method</p>
3816
- </p>
3817
- <p></p>
3818
- </div>
3819
-
3820
-
3821
-
3822
-
3823
-
3824
-
3825
- <div class="code-arguments-hdr">Arguments</div>
3826
- <table class="params code-arguments">
3827
- <tr>
3828
- <th class="hdr-name">Name</th>
3829
- <th class="hdr-type">Type</th>
3830
- <th class="hdr-desc">Description</th>
3831
- </tr>
3832
-
3833
- <tr class="code-arg">
3834
- <td>
3835
- <strong class="code-arg-name">metadataKey</strong>
3836
- </td>
3837
- <td class="code-arg-types">
3838
-
3839
- <code>string</code>
3840
-
3841
-
3842
- </td>
3843
- <td class="code-arg-desc">
3844
- <!--
3845
- Used for displaying comments in Class, Interface, Properties Constructor,
3846
- Function and Parameters of constructor or function.
3847
- (Excludes Type alias).
3848
- -->
3849
-
3850
-
3851
-
3852
-
3853
-
3854
- </td>
3855
- </tr>
3856
-
3857
- <tr class="code-arg">
3858
- <td>
3859
- <strong class="code-arg-name">metadataValue</strong>
3860
- </td>
3861
- <td class="code-arg-types">
3862
-
3863
- <code>any</code>
3864
-
3865
-
3866
- </td>
3867
- <td class="code-arg-desc">
3868
- <!--
3869
- Used for displaying comments in Class, Interface, Properties Constructor,
3870
- Function and Parameters of constructor or function.
3871
- (Excludes Type alias).
3872
- -->
3873
-
3874
-
3875
-
3876
-
3877
-
3878
- </td>
3879
- </tr>
3880
-
3881
- <tr class="code-arg">
3882
- <td>
3883
- <strong class="code-arg-name">target</strong>
3884
- </td>
3885
- <td class="code-arg-types">
3886
-
3887
- <code><a href="#Object">Object</a></code>
3888
-
3889
-
3890
- </td>
3891
- <td class="code-arg-desc">
3892
- <!--
3893
- Used for displaying comments in Class, Interface, Properties Constructor,
3894
- Function and Parameters of constructor or function.
3895
- (Excludes Type alias).
3896
- -->
3897
-
3898
-
3899
-
3900
-
3901
-
3902
- </td>
3903
- </tr>
3904
-
3905
- <tr class="code-arg">
3906
- <td>
3907
- <strong class="code-arg-name">propertyKey</strong>
3908
- </td>
3909
- <td class="code-arg-types">
3910
-
3911
- <code></code>
3912
-
3913
-
3914
- </td>
3915
- <td class="code-arg-desc">
3916
- <!--
3917
- Used for displaying comments in Class, Interface, Properties Constructor,
3918
- Function and Parameters of constructor or function.
3919
- (Excludes Type alias).
3920
- -->
3921
-
3922
-
3923
-
3924
-
3925
-
3926
- </td>
3927
- </tr>
3928
-
3929
- </table>
3930
-
3931
- </section>
3932
-
3933
-
3934
-
3935
- <section class="code-doc ">
3936
- <a name="132450"></a>
3937
-
3938
- <h4 class="code-ref">deleteMetadata(metadataKey: string, target: <a href="#Object">Object</a>, propertyKey: undefined) : boolean</h4>
3939
-
3940
-
3941
- <!--
3942
- Used for displaying comments in Class, Interface, Properties Constructor,
3943
- Function and Parameters of constructor or function.
3944
- (Excludes Type alias).
3945
- -->
3946
-
3947
-
3948
-
3949
-
3950
-
3951
-
3952
- <div class="code-arguments-hdr">Arguments</div>
3953
- <table class="params code-arguments">
3954
- <tr>
3955
- <th class="hdr-name">Name</th>
3956
- <th class="hdr-type">Type</th>
3957
- <th class="hdr-desc">Description</th>
3958
- </tr>
3959
-
3960
- <tr class="code-arg">
3961
- <td>
3962
- <strong class="code-arg-name">metadataKey</strong>
3963
- </td>
3964
- <td class="code-arg-types">
3965
-
3966
- <code>string</code>
3967
-
3968
-
3969
- </td>
3970
- <td class="code-arg-desc">
3971
- <!--
3972
- Used for displaying comments in Class, Interface, Properties Constructor,
3973
- Function and Parameters of constructor or function.
3974
- (Excludes Type alias).
3975
- -->
3976
-
3977
-
3978
-
3979
-
3980
-
3981
- </td>
3982
- </tr>
3983
-
3984
- <tr class="code-arg">
3985
- <td>
3986
- <strong class="code-arg-name">target</strong>
3987
- </td>
3988
- <td class="code-arg-types">
3989
-
3990
- <code><a href="#Object">Object</a></code>
3991
-
3992
-
3993
- </td>
3994
- <td class="code-arg-desc">
3995
- <!--
3996
- Used for displaying comments in Class, Interface, Properties Constructor,
3997
- Function and Parameters of constructor or function.
3998
- (Excludes Type alias).
3999
- -->
4000
-
4001
-
4002
-
4003
-
4004
-
4005
- </td>
4006
- </tr>
4007
-
4008
- <tr class="code-arg">
4009
- <td>
4010
- <strong class="code-arg-name">propertyKey</strong>
4011
- </td>
4012
- <td class="code-arg-types">
4013
-
4014
- <code></code>
4015
-
4016
-
4017
- </td>
4018
- <td class="code-arg-desc">
4019
- <!--
4020
- Used for displaying comments in Class, Interface, Properties Constructor,
4021
- Function and Parameters of constructor or function.
4022
- (Excludes Type alias).
4023
- -->
4024
-
4025
-
4026
-
4027
-
4028
-
4029
- </td>
4030
- </tr>
4031
-
4032
- </table>
4033
-
4034
- </section>
4035
-
4036
-
4037
-
4038
- <section class="code-doc ">
4039
- <a name="132430"></a>
4040
-
4041
- <h4 class="code-ref">getMetadata(metadataKey: string, target: <a href="#Object">Object</a>, propertyKey: undefined) : any</h4>
4042
-
4043
-
4044
- <!--
4045
- Used for displaying comments in Class, Interface, Properties Constructor,
4046
- Function and Parameters of constructor or function.
4047
- (Excludes Type alias).
4048
- -->
4049
-
4050
- <div class="code-desc">
4051
- <p><p>lookup metadata from a target object and its prototype chain</p>
4052
- </p>
4053
- <p></p>
4054
- </div>
4055
-
4056
-
4057
-
4058
-
4059
-
4060
-
4061
- <div class="code-arguments-hdr">Arguments</div>
4062
- <table class="params code-arguments">
4063
- <tr>
4064
- <th class="hdr-name">Name</th>
4065
- <th class="hdr-type">Type</th>
4066
- <th class="hdr-desc">Description</th>
4067
- </tr>
4068
-
4069
- <tr class="code-arg">
4070
- <td>
4071
- <strong class="code-arg-name">metadataKey</strong>
4072
- </td>
4073
- <td class="code-arg-types">
4074
-
4075
- <code>string</code>
4076
-
4077
-
4078
- </td>
4079
- <td class="code-arg-desc">
4080
- <!--
4081
- Used for displaying comments in Class, Interface, Properties Constructor,
4082
- Function and Parameters of constructor or function.
4083
- (Excludes Type alias).
4084
- -->
4085
-
4086
-
4087
-
4088
-
4089
-
4090
- </td>
4091
- </tr>
4092
-
4093
- <tr class="code-arg">
4094
- <td>
4095
- <strong class="code-arg-name">target</strong>
4096
- </td>
4097
- <td class="code-arg-types">
4098
-
4099
- <code><a href="#Object">Object</a></code>
4100
-
4101
-
4102
- </td>
4103
- <td class="code-arg-desc">
4104
- <!--
4105
- Used for displaying comments in Class, Interface, Properties Constructor,
4106
- Function and Parameters of constructor or function.
4107
- (Excludes Type alias).
4108
- -->
4109
-
4110
-
4111
-
4112
-
4113
-
4114
- </td>
4115
- </tr>
4116
-
4117
- <tr class="code-arg">
4118
- <td>
4119
- <strong class="code-arg-name">propertyKey</strong>
4120
- </td>
4121
- <td class="code-arg-types">
4122
-
4123
- <code></code>
4124
-
4125
-
4126
- </td>
4127
- <td class="code-arg-desc">
4128
- <!--
4129
- Used for displaying comments in Class, Interface, Properties Constructor,
4130
- Function and Parameters of constructor or function.
4131
- (Excludes Type alias).
4132
- -->
4133
-
4134
-
4135
-
4136
-
4137
-
4138
- </td>
4139
- </tr>
4140
-
4141
- </table>
4142
-
4143
- </section>
4144
-
4145
-
4146
-
4147
- <section class="code-doc ">
4148
- <a name="132455"></a>
4149
-
4150
- <h4 class="code-ref">getMetadataKeys(target: <a href="#Object">Object</a>, propertyKey: undefined) : </h4>
4151
-
4152
-
4153
- <!--
4154
- Used for displaying comments in Class, Interface, Properties Constructor,
4155
- Function and Parameters of constructor or function.
4156
- (Excludes Type alias).
4157
- -->
4158
-
4159
-
4160
-
4161
-
4162
-
4163
-
4164
- <div class="code-arguments-hdr">Arguments</div>
4165
- <table class="params code-arguments">
4166
- <tr>
4167
- <th class="hdr-name">Name</th>
4168
- <th class="hdr-type">Type</th>
4169
- <th class="hdr-desc">Description</th>
4170
- </tr>
4171
-
4172
- <tr class="code-arg">
4173
- <td>
4174
- <strong class="code-arg-name">target</strong>
4175
- </td>
4176
- <td class="code-arg-types">
4177
-
4178
- <code><a href="#Object">Object</a></code>
4179
-
4180
-
4181
- </td>
4182
- <td class="code-arg-desc">
4183
- <!--
4184
- Used for displaying comments in Class, Interface, Properties Constructor,
4185
- Function and Parameters of constructor or function.
4186
- (Excludes Type alias).
4187
- -->
4188
-
4189
-
4190
-
4191
-
4192
-
4193
- </td>
4194
- </tr>
4195
-
4196
- <tr class="code-arg">
4197
- <td>
4198
- <strong class="code-arg-name">propertyKey</strong>
4199
- </td>
4200
- <td class="code-arg-types">
4201
-
4202
- <code></code>
4203
-
4204
-
4205
- </td>
4206
- <td class="code-arg-desc">
4207
- <!--
4208
- Used for displaying comments in Class, Interface, Properties Constructor,
4209
- Function and Parameters of constructor or function.
4210
- (Excludes Type alias).
4211
- -->
4212
-
4213
-
4214
-
4215
-
4216
-
4217
- </td>
4218
- </tr>
4219
-
4220
- </table>
4221
-
4222
- </section>
4223
-
4224
-
4225
-
4226
- <section class="code-doc ">
4227
- <a name="132435"></a>
4228
-
4229
- <h4 class="code-ref">getOwnMetadata(metadataKey: string, target: <a href="#Object">Object</a>, propertyKey: undefined) : any</h4>
4230
-
4231
-
4232
- <!--
4233
- Used for displaying comments in Class, Interface, Properties Constructor,
4234
- Function and Parameters of constructor or function.
4235
- (Excludes Type alias).
4236
- -->
4237
-
4238
- <div class="code-desc">
4239
- <p><p>get own metadata for a target object or it&#39;s property/method</p>
4240
- </p>
4241
- <p></p>
4242
- </div>
4243
-
4244
-
4245
-
4246
-
4247
-
4248
-
4249
- <div class="code-arguments-hdr">Arguments</div>
4250
- <table class="params code-arguments">
4251
- <tr>
4252
- <th class="hdr-name">Name</th>
4253
- <th class="hdr-type">Type</th>
4254
- <th class="hdr-desc">Description</th>
4255
- </tr>
4256
-
4257
- <tr class="code-arg">
4258
- <td>
4259
- <strong class="code-arg-name">metadataKey</strong>
4260
- </td>
4261
- <td class="code-arg-types">
4262
-
4263
- <code>string</code>
4264
-
4265
-
4266
- </td>
4267
- <td class="code-arg-desc">
4268
- <!--
4269
- Used for displaying comments in Class, Interface, Properties Constructor,
4270
- Function and Parameters of constructor or function.
4271
- (Excludes Type alias).
4272
- -->
4273
-
4274
-
4275
-
4276
-
4277
-
4278
- </td>
4279
- </tr>
4280
-
4281
- <tr class="code-arg">
4282
- <td>
4283
- <strong class="code-arg-name">target</strong>
4284
- </td>
4285
- <td class="code-arg-types">
4286
-
4287
- <code><a href="#Object">Object</a></code>
4288
-
4289
-
4290
- </td>
4291
- <td class="code-arg-desc">
4292
- <!--
4293
- Used for displaying comments in Class, Interface, Properties Constructor,
4294
- Function and Parameters of constructor or function.
4295
- (Excludes Type alias).
4296
- -->
4297
-
4298
-
4299
-
4300
-
4301
-
4302
- </td>
4303
- </tr>
4304
-
4305
- <tr class="code-arg">
4306
- <td>
4307
- <strong class="code-arg-name">propertyKey</strong>
4308
- </td>
4309
- <td class="code-arg-types">
4310
-
4311
- <code></code>
4312
-
4313
-
4314
- </td>
4315
- <td class="code-arg-desc">
4316
- <!--
4317
- Used for displaying comments in Class, Interface, Properties Constructor,
4318
- Function and Parameters of constructor or function.
4319
- (Excludes Type alias).
4320
- -->
4321
-
4322
-
4323
-
4324
-
4325
-
4326
- </td>
4327
- </tr>
4328
-
4329
- </table>
4330
-
4331
- </section>
4332
-
4333
-
4334
-
4335
- <section class="code-doc ">
4336
- <a name="132459"></a>
4337
-
4338
- <h4 class="code-ref">getOwnMetadataKeys(target: <a href="#Object">Object</a>, propertyKey: undefined) : </h4>
4339
-
4340
-
4341
- <!--
4342
- Used for displaying comments in Class, Interface, Properties Constructor,
4343
- Function and Parameters of constructor or function.
4344
- (Excludes Type alias).
4345
- -->
4346
-
4347
-
4348
-
4349
-
4350
-
4351
-
4352
- <div class="code-arguments-hdr">Arguments</div>
4353
- <table class="params code-arguments">
4354
- <tr>
4355
- <th class="hdr-name">Name</th>
4356
- <th class="hdr-type">Type</th>
4357
- <th class="hdr-desc">Description</th>
4358
- </tr>
4359
-
4360
- <tr class="code-arg">
4361
- <td>
4362
- <strong class="code-arg-name">target</strong>
4363
- </td>
4364
- <td class="code-arg-types">
4365
-
4366
- <code><a href="#Object">Object</a></code>
4367
-
4368
-
4369
- </td>
4370
- <td class="code-arg-desc">
4371
- <!--
4372
- Used for displaying comments in Class, Interface, Properties Constructor,
4373
- Function and Parameters of constructor or function.
4374
- (Excludes Type alias).
4375
- -->
4376
-
4377
-
4378
-
4379
-
4380
-
4381
- </td>
4382
- </tr>
4383
-
4384
- <tr class="code-arg">
4385
- <td>
4386
- <strong class="code-arg-name">propertyKey</strong>
4387
- </td>
4388
- <td class="code-arg-types">
4389
-
4390
- <code></code>
4391
-
4392
-
4393
- </td>
4394
- <td class="code-arg-desc">
4395
- <!--
4396
- Used for displaying comments in Class, Interface, Properties Constructor,
4397
- Function and Parameters of constructor or function.
4398
- (Excludes Type alias).
4399
- -->
4400
-
4401
-
4402
-
4403
-
4404
-
4405
- </td>
4406
- </tr>
4407
-
4408
- </table>
4409
-
4410
- </section>
4411
-
4412
-
4413
-
4414
- <section class="code-doc ">
4415
- <a name="132440"></a>
4416
-
4417
- <h4 class="code-ref">hasMetadata(metadataKey: string, target: <a href="#Object">Object</a>, propertyKey: undefined) : boolean</h4>
4418
-
4419
-
4420
- <!--
4421
- Used for displaying comments in Class, Interface, Properties Constructor,
4422
- Function and Parameters of constructor or function.
4423
- (Excludes Type alias).
4424
- -->
4425
-
4426
- <div class="code-desc">
4427
- <p><p>Check if the target has corresponding metadata</p>
4428
- </p>
4429
- <p></p>
4430
- </div>
4431
-
4432
-
4433
-
4434
-
4435
-
4436
-
4437
- <div class="code-arguments-hdr">Arguments</div>
4438
- <table class="params code-arguments">
4439
- <tr>
4440
- <th class="hdr-name">Name</th>
4441
- <th class="hdr-type">Type</th>
4442
- <th class="hdr-desc">Description</th>
4443
- </tr>
4444
-
4445
- <tr class="code-arg">
4446
- <td>
4447
- <strong class="code-arg-name">metadataKey</strong>
4448
- </td>
4449
- <td class="code-arg-types">
4450
-
4451
- <code>string</code>
4452
-
4453
-
4454
- </td>
4455
- <td class="code-arg-desc">
4456
- <!--
4457
- Used for displaying comments in Class, Interface, Properties Constructor,
4458
- Function and Parameters of constructor or function.
4459
- (Excludes Type alias).
4460
- -->
4461
-
4462
- <div class="code-desc">
4463
- <p></p>
4464
- <p><p>Key</p>
4465
- </p>
4466
- </div>
4467
-
4468
-
4469
-
4470
-
4471
-
4472
- </td>
4473
- </tr>
4474
-
4475
- <tr class="code-arg">
4476
- <td>
4477
- <strong class="code-arg-name">target</strong>
4478
- </td>
4479
- <td class="code-arg-types">
4480
-
4481
- <code><a href="#Object">Object</a></code>
4482
-
4483
-
4484
- </td>
4485
- <td class="code-arg-desc">
4486
- <!--
4487
- Used for displaying comments in Class, Interface, Properties Constructor,
4488
- Function and Parameters of constructor or function.
4489
- (Excludes Type alias).
4490
- -->
4491
-
4492
- <div class="code-desc">
4493
- <p></p>
4494
- <p><p>Target</p>
4495
- </p>
4496
- </div>
4497
-
4498
-
4499
-
4500
-
4501
-
4502
- </td>
4503
- </tr>
4504
-
4505
- <tr class="code-arg">
4506
- <td>
4507
- <strong class="code-arg-name">propertyKey</strong>
4508
- </td>
4509
- <td class="code-arg-types">
4510
-
4511
- <code></code>
4512
-
4513
-
4514
- </td>
4515
- <td class="code-arg-desc">
4516
- <!--
4517
- Used for displaying comments in Class, Interface, Properties Constructor,
4518
- Function and Parameters of constructor or function.
4519
- (Excludes Type alias).
4520
- -->
4521
-
4522
- <div class="code-desc">
4523
- <p></p>
4524
- <p><p>Optional property key</p>
4525
- </p>
4526
- </div>
4527
-
4528
-
4529
-
4530
-
4531
-
4532
- </td>
4533
- </tr>
4534
-
4535
- </table>
4536
-
4537
- </section>
4538
-
4539
-
4540
-
4541
- <section class="code-doc ">
4542
- <a name="132445"></a>
4543
-
4544
- <h4 class="code-ref">hasOwnMetadata(metadataKey: string, target: <a href="#Object">Object</a>, propertyKey: undefined) : boolean</h4>
4545
-
4546
-
4547
- <!--
4548
- Used for displaying comments in Class, Interface, Properties Constructor,
4549
- Function and Parameters of constructor or function.
4550
- (Excludes Type alias).
4551
- -->
4552
-
4553
-
4554
-
4555
-
4556
-
4557
-
4558
- <div class="code-arguments-hdr">Arguments</div>
4559
- <table class="params code-arguments">
4560
- <tr>
4561
- <th class="hdr-name">Name</th>
4562
- <th class="hdr-type">Type</th>
4563
- <th class="hdr-desc">Description</th>
4564
- </tr>
4565
-
4566
- <tr class="code-arg">
4567
- <td>
4568
- <strong class="code-arg-name">metadataKey</strong>
4569
- </td>
4570
- <td class="code-arg-types">
4571
-
4572
- <code>string</code>
4573
-
4574
-
4575
- </td>
4576
- <td class="code-arg-desc">
4577
- <!--
4578
- Used for displaying comments in Class, Interface, Properties Constructor,
4579
- Function and Parameters of constructor or function.
4580
- (Excludes Type alias).
4581
- -->
4582
-
4583
-
4584
-
4585
-
4586
-
4587
- </td>
4588
- </tr>
4589
-
4590
- <tr class="code-arg">
4591
- <td>
4592
- <strong class="code-arg-name">target</strong>
4593
- </td>
4594
- <td class="code-arg-types">
4595
-
4596
- <code><a href="#Object">Object</a></code>
4597
-
4598
-
4599
- </td>
4600
- <td class="code-arg-desc">
4601
- <!--
4602
- Used for displaying comments in Class, Interface, Properties Constructor,
4603
- Function and Parameters of constructor or function.
4604
- (Excludes Type alias).
4605
- -->
4606
-
4607
-
4608
-
4609
-
4610
-
4611
- </td>
4612
- </tr>
4613
-
4614
- <tr class="code-arg">
4615
- <td>
4616
- <strong class="code-arg-name">propertyKey</strong>
4617
- </td>
4618
- <td class="code-arg-types">
4619
-
4620
- <code></code>
4621
-
4622
-
4623
- </td>
4624
- <td class="code-arg-desc">
4625
- <!--
4626
- Used for displaying comments in Class, Interface, Properties Constructor,
4627
- Function and Parameters of constructor or function.
4628
- (Excludes Type alias).
4629
- -->
4630
-
4631
-
4632
-
4633
-
4634
-
4635
- </td>
4636
- </tr>
4637
-
4638
- </table>
4639
-
4640
- </section>
4641
-
4642
-
4643
-
4644
- <section class="code-doc ">
4645
- <a name="132479"></a>
4646
-
4647
- <h4 class="code-ref">metadata(metadataKey: string, metadataValue: any) : </h4>
4648
-
4649
-
4650
- <!--
4651
- Used for displaying comments in Class, Interface, Properties Constructor,
4652
- Function and Parameters of constructor or function.
4653
- (Excludes Type alias).
4654
- -->
4655
-
4656
-
4657
-
4658
-
4659
-
4660
-
4661
- <div class="code-arguments-hdr">Arguments</div>
4662
- <table class="params code-arguments">
4663
- <tr>
4664
- <th class="hdr-name">Name</th>
4665
- <th class="hdr-type">Type</th>
4666
- <th class="hdr-desc">Description</th>
4667
- </tr>
4668
-
4669
- <tr class="code-arg">
4670
- <td>
4671
- <strong class="code-arg-name">metadataKey</strong>
4672
- </td>
4673
- <td class="code-arg-types">
4674
-
4675
- <code>string</code>
4676
-
4677
-
4678
- </td>
4679
- <td class="code-arg-desc">
4680
- <!--
4681
- Used for displaying comments in Class, Interface, Properties Constructor,
4682
- Function and Parameters of constructor or function.
4683
- (Excludes Type alias).
4684
- -->
4685
-
4686
-
4687
-
4688
-
4689
-
4690
- </td>
4691
- </tr>
4692
-
4693
- <tr class="code-arg">
4694
- <td>
4695
- <strong class="code-arg-name">metadataValue</strong>
4696
- </td>
4697
- <td class="code-arg-types">
4698
-
4699
- <code>any</code>
4700
-
4701
-
4702
- </td>
4703
- <td class="code-arg-desc">
4704
- <!--
4705
- Used for displaying comments in Class, Interface, Properties Constructor,
4706
- Function and Parameters of constructor or function.
4707
- (Excludes Type alias).
4708
- -->
4709
-
4710
-
4711
-
4712
-
4713
-
4714
- </td>
4715
- </tr>
4716
-
4717
- </table>
4718
-
4719
- </section>
4720
-
4721
-
4722
-
4723
-
4724
-
4725
- </div>
4726
- <div class="intentionally-left-blank"></div>
4727
- </div>
4728
- </div>
4729
- <script src="js/vendor/jquery-1.10.1.min.js"></script>
4730
- <script src="js/vendor/jquery.scrollTo-1.4.3.1.js"></script>
4731
- <script src="js/vendor/bootstrap.min.js"></script>
4732
- <script src="js/main.js"></script>
4733
- </body>
4734
- </html>
4735
-