@microsoft/api-extractor-model 7.15.2 → 7.16.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 (57) hide show
  1. package/README.md +68 -68
  2. package/dist/rollup.d.ts +16 -4
  3. package/dist/tsdoc-metadata.json +1 -1
  4. package/lib/aedoc/AedocDefinitions.js.map +1 -1
  5. package/lib/aedoc/ReleaseTag.js.map +1 -1
  6. package/lib/index.js.map +1 -1
  7. package/lib/items/ApiDeclaredItem.js.map +1 -1
  8. package/lib/items/ApiDocumentedItem.js.map +1 -1
  9. package/lib/items/ApiItem.js.map +1 -1
  10. package/lib/items/ApiPropertyItem.js.map +1 -1
  11. package/lib/mixins/ApiItemContainerMixin.js.map +1 -1
  12. package/lib/mixins/ApiNameMixin.js.map +1 -1
  13. package/lib/mixins/ApiOptionalMixin.js.map +1 -1
  14. package/lib/mixins/ApiParameterListMixin.d.ts +1 -0
  15. package/lib/mixins/ApiParameterListMixin.d.ts.map +1 -1
  16. package/lib/mixins/ApiParameterListMixin.js +4 -1
  17. package/lib/mixins/ApiParameterListMixin.js.map +1 -1
  18. package/lib/mixins/ApiReleaseTagMixin.js.map +1 -1
  19. package/lib/mixins/ApiReturnTypeMixin.js.map +1 -1
  20. package/lib/mixins/ApiStaticMixin.js.map +1 -1
  21. package/lib/mixins/ApiTypeParameterListMixin.js.map +1 -1
  22. package/lib/mixins/Excerpt.js.map +1 -1
  23. package/lib/mixins/Mixin.js.map +1 -1
  24. package/lib/model/ApiCallSignature.js.map +1 -1
  25. package/lib/model/ApiClass.js.map +1 -1
  26. package/lib/model/ApiConstructSignature.js.map +1 -1
  27. package/lib/model/ApiConstructor.js.map +1 -1
  28. package/lib/model/ApiEntryPoint.js.map +1 -1
  29. package/lib/model/ApiEnum.js.map +1 -1
  30. package/lib/model/ApiEnumMember.js.map +1 -1
  31. package/lib/model/ApiFunction.js.map +1 -1
  32. package/lib/model/ApiIndexSignature.js.map +1 -1
  33. package/lib/model/ApiInterface.js.map +1 -1
  34. package/lib/model/ApiMethod.js.map +1 -1
  35. package/lib/model/ApiMethodSignature.js.map +1 -1
  36. package/lib/model/ApiModel.js.map +1 -1
  37. package/lib/model/ApiNamespace.js.map +1 -1
  38. package/lib/model/ApiPackage.js.map +1 -1
  39. package/lib/model/ApiProperty.js.map +1 -1
  40. package/lib/model/ApiPropertySignature.js.map +1 -1
  41. package/lib/model/ApiTypeAlias.js.map +1 -1
  42. package/lib/model/ApiVariable.js.map +1 -1
  43. package/lib/model/Deserializer.js.map +1 -1
  44. package/lib/model/DeserializerContext.d.ts +10 -4
  45. package/lib/model/DeserializerContext.d.ts.map +1 -1
  46. package/lib/model/DeserializerContext.js +10 -4
  47. package/lib/model/DeserializerContext.js.map +1 -1
  48. package/lib/model/HeritageType.js.map +1 -1
  49. package/lib/model/ModelReferenceResolver.js.map +1 -1
  50. package/lib/model/Parameter.d.ts +5 -0
  51. package/lib/model/Parameter.d.ts.map +1 -1
  52. package/lib/model/Parameter.js +1 -0
  53. package/lib/model/Parameter.js.map +1 -1
  54. package/lib/model/TypeParameter.js.map +1 -1
  55. package/package.json +31 -28
  56. package/CHANGELOG.json +0 -1553
  57. package/CHANGELOG.md +0 -648
package/CHANGELOG.md DELETED
@@ -1,648 +0,0 @@
1
- # Change Log - @microsoft/api-extractor-model
2
-
3
- This log was last generated on Mon, 27 Dec 2021 16:10:40 GMT and should not be manually modified.
4
-
5
- ## 7.15.2
6
- Mon, 27 Dec 2021 16:10:40 GMT
7
-
8
- _Version update only_
9
-
10
- ## 7.15.1
11
- Thu, 09 Dec 2021 20:34:41 GMT
12
-
13
- _Version update only_
14
-
15
- ## 7.15.0
16
- Thu, 09 Dec 2021 00:21:54 GMT
17
-
18
- ### Minor changes
19
-
20
- - Replace const enums with conventional enums to allow for compatibility with JavaScript consumers.
21
-
22
- ## 7.14.0
23
- Wed, 08 Dec 2021 16:14:05 GMT
24
-
25
- ### Minor changes
26
-
27
- - Update to TypeScript 4.5
28
-
29
- ## 7.13.18
30
- Mon, 06 Dec 2021 16:08:33 GMT
31
-
32
- _Version update only_
33
-
34
- ## 7.13.17
35
- Fri, 03 Dec 2021 03:05:22 GMT
36
-
37
- _Version update only_
38
-
39
- ## 7.13.16
40
- Sat, 06 Nov 2021 00:09:13 GMT
41
-
42
- _Version update only_
43
-
44
- ## 7.13.15
45
- Fri, 05 Nov 2021 15:09:18 GMT
46
-
47
- _Version update only_
48
-
49
- ## 7.13.14
50
- Wed, 27 Oct 2021 00:08:15 GMT
51
-
52
- ### Patches
53
-
54
- - Update the package.json repository field to include the directory property.
55
-
56
- ## 7.13.13
57
- Wed, 13 Oct 2021 15:09:54 GMT
58
-
59
- _Version update only_
60
-
61
- ## 7.13.12
62
- Fri, 08 Oct 2021 08:08:34 GMT
63
-
64
- _Version update only_
65
-
66
- ## 7.13.11
67
- Thu, 07 Oct 2021 07:13:35 GMT
68
-
69
- _Version update only_
70
-
71
- ## 7.13.10
72
- Tue, 05 Oct 2021 15:08:38 GMT
73
-
74
- _Version update only_
75
-
76
- ## 7.13.9
77
- Fri, 24 Sep 2021 00:09:29 GMT
78
-
79
- _Version update only_
80
-
81
- ## 7.13.8
82
- Thu, 23 Sep 2021 00:10:40 GMT
83
-
84
- ### Patches
85
-
86
- - Upgrade the `@types/node` dependency to version to version 12.
87
-
88
- ## 7.13.7
89
- Tue, 14 Sep 2021 01:17:04 GMT
90
-
91
- _Version update only_
92
-
93
- ## 7.13.6
94
- Mon, 13 Sep 2021 15:07:06 GMT
95
-
96
- _Version update only_
97
-
98
- ## 7.13.5
99
- Wed, 11 Aug 2021 00:07:21 GMT
100
-
101
- _Version update only_
102
-
103
- ## 7.13.4
104
- Mon, 12 Jul 2021 23:08:26 GMT
105
-
106
- _Version update only_
107
-
108
- ## 7.13.3
109
- Fri, 04 Jun 2021 19:59:53 GMT
110
-
111
- _Version update only_
112
-
113
- ## 7.13.2
114
- Wed, 19 May 2021 00:11:39 GMT
115
-
116
- _Version update only_
117
-
118
- ## 7.13.1
119
- Mon, 03 May 2021 15:10:29 GMT
120
-
121
- _Version update only_
122
-
123
- ## 7.13.0
124
- Tue, 20 Apr 2021 04:59:51 GMT
125
-
126
- ### Minor changes
127
-
128
- - The .api.json file format now stores the TSDoc configuration used for parsing doc comments
129
-
130
- ## 7.12.5
131
- Mon, 12 Apr 2021 15:10:28 GMT
132
-
133
- _Version update only_
134
-
135
- ## 7.12.4
136
- Thu, 08 Apr 2021 06:05:31 GMT
137
-
138
- ### Patches
139
-
140
- - Fix minor typo in README.md
141
-
142
- ## 7.12.3
143
- Tue, 06 Apr 2021 15:14:22 GMT
144
-
145
- _Version update only_
146
-
147
- ## 7.12.2
148
- Fri, 05 Feb 2021 16:10:42 GMT
149
-
150
- _Version update only_
151
-
152
- ## 7.12.1
153
- Thu, 10 Dec 2020 23:25:49 GMT
154
-
155
- ### Patches
156
-
157
- - Enable support for @decorator
158
-
159
- ## 7.12.0
160
- Wed, 18 Nov 2020 08:19:54 GMT
161
-
162
- ### Minor changes
163
-
164
- - Introduce an ApiOptionalMixin base class for representing optional properties and methods
165
-
166
- ## 7.11.0
167
- Wed, 18 Nov 2020 06:21:57 GMT
168
-
169
- ### Minor changes
170
-
171
- - Update .api.json file format to store a new field "isOptional" for documenting optional properties
172
-
173
- ## 7.10.10
174
- Wed, 11 Nov 2020 01:08:59 GMT
175
-
176
- _Version update only_
177
-
178
- ## 7.10.9
179
- Tue, 10 Nov 2020 23:13:12 GMT
180
-
181
- _Version update only_
182
-
183
- ## 7.10.8
184
- Fri, 30 Oct 2020 06:38:39 GMT
185
-
186
- _Version update only_
187
-
188
- ## 7.10.7
189
- Fri, 30 Oct 2020 00:10:14 GMT
190
-
191
- _Version update only_
192
-
193
- ## 7.10.6
194
- Thu, 29 Oct 2020 06:14:19 GMT
195
-
196
- ### Patches
197
-
198
- - Fix .d.ts error when the library is imported by a project using TypeScript 4.0
199
-
200
- ## 7.10.5
201
- Wed, 28 Oct 2020 01:18:03 GMT
202
-
203
- _Version update only_
204
-
205
- ## 7.10.4
206
- Tue, 27 Oct 2020 15:10:14 GMT
207
-
208
- _Version update only_
209
-
210
- ## 7.10.3
211
- Tue, 06 Oct 2020 00:24:06 GMT
212
-
213
- _Version update only_
214
-
215
- ## 7.10.2
216
- Mon, 05 Oct 2020 22:36:57 GMT
217
-
218
- _Version update only_
219
-
220
- ## 7.10.1
221
- Wed, 30 Sep 2020 18:39:17 GMT
222
-
223
- ### Patches
224
-
225
- - Update to build with @rushstack/heft-node-rig
226
-
227
- ## 7.10.0
228
- Wed, 30 Sep 2020 06:53:53 GMT
229
-
230
- ### Minor changes
231
-
232
- - Upgrade compiler; the API now requires TypeScript 3.9 or newer
233
-
234
- ### Patches
235
-
236
- - Update README.md
237
-
238
- ## 7.9.7
239
- Tue, 22 Sep 2020 05:45:57 GMT
240
-
241
- _Version update only_
242
-
243
- ## 7.9.6
244
- Tue, 22 Sep 2020 01:45:31 GMT
245
-
246
- _Version update only_
247
-
248
- ## 7.9.5
249
- Tue, 22 Sep 2020 00:08:53 GMT
250
-
251
- _Version update only_
252
-
253
- ## 7.9.4
254
- Sat, 19 Sep 2020 04:37:27 GMT
255
-
256
- _Version update only_
257
-
258
- ## 7.9.3
259
- Sat, 19 Sep 2020 03:33:07 GMT
260
-
261
- _Version update only_
262
-
263
- ## 7.9.2
264
- Fri, 18 Sep 2020 22:57:24 GMT
265
-
266
- _Version update only_
267
-
268
- ## 7.9.1
269
- Fri, 18 Sep 2020 21:49:54 GMT
270
-
271
- _Version update only_
272
-
273
- ## 7.9.0
274
- Sun, 13 Sep 2020 01:53:20 GMT
275
-
276
- ### Minor changes
277
-
278
- - Add support for system selectors in declaration references
279
-
280
- ## 7.8.22
281
- Fri, 11 Sep 2020 02:13:35 GMT
282
-
283
- _Version update only_
284
-
285
- ## 7.8.21
286
- Mon, 07 Sep 2020 07:37:37 GMT
287
-
288
- _Version update only_
289
-
290
- ## 7.8.20
291
- Sat, 05 Sep 2020 18:56:34 GMT
292
-
293
- ### Patches
294
-
295
- - Fix "Converting circular structure to JSON" error (GitHub #2152)
296
-
297
- ## 7.8.19
298
- Thu, 27 Aug 2020 11:27:06 GMT
299
-
300
- _Version update only_
301
-
302
- ## 7.8.18
303
- Mon, 24 Aug 2020 07:35:20 GMT
304
-
305
- _Version update only_
306
-
307
- ## 7.8.17
308
- Sat, 22 Aug 2020 05:55:43 GMT
309
-
310
- _Version update only_
311
-
312
- ## 7.8.16
313
- Tue, 18 Aug 2020 23:59:42 GMT
314
-
315
- _Version update only_
316
-
317
- ## 7.8.15
318
- Mon, 17 Aug 2020 04:53:23 GMT
319
-
320
- _Version update only_
321
-
322
- ## 7.8.14
323
- Wed, 12 Aug 2020 00:10:05 GMT
324
-
325
- ### Patches
326
-
327
- - Updated project to build with Heft
328
-
329
- ## 7.8.13
330
- Wed, 05 Aug 2020 18:27:33 GMT
331
-
332
- _Version update only_
333
-
334
- ## 7.8.12
335
- Fri, 03 Jul 2020 15:09:04 GMT
336
-
337
- _Version update only_
338
-
339
- ## 7.8.11
340
- Thu, 25 Jun 2020 06:43:35 GMT
341
-
342
- _Version update only_
343
-
344
- ## 7.8.10
345
- Wed, 24 Jun 2020 09:50:48 GMT
346
-
347
- _Version update only_
348
-
349
- ## 7.8.9
350
- Wed, 24 Jun 2020 09:04:28 GMT
351
-
352
- _Version update only_
353
-
354
- ## 7.8.8
355
- Wed, 10 Jun 2020 20:48:30 GMT
356
-
357
- _Version update only_
358
-
359
- ## 7.8.7
360
- Sat, 30 May 2020 02:59:54 GMT
361
-
362
- _Version update only_
363
-
364
- ## 7.8.6
365
- Thu, 28 May 2020 05:59:02 GMT
366
-
367
- _Version update only_
368
-
369
- ## 7.8.5
370
- Wed, 27 May 2020 05:15:11 GMT
371
-
372
- _Version update only_
373
-
374
- ## 7.8.4
375
- Tue, 26 May 2020 23:00:25 GMT
376
-
377
- _Version update only_
378
-
379
- ## 7.8.3
380
- Fri, 22 May 2020 15:08:43 GMT
381
-
382
- _Version update only_
383
-
384
- ## 7.8.2
385
- Thu, 21 May 2020 23:09:44 GMT
386
-
387
- _Version update only_
388
-
389
- ## 7.8.1
390
- Thu, 21 May 2020 15:42:00 GMT
391
-
392
- _Version update only_
393
-
394
- ## 7.8.0
395
- Wed, 06 May 2020 08:23:45 GMT
396
-
397
- ### Minor changes
398
-
399
- - Enable canonicalReference to ApiItem lookup
400
-
401
- ## 7.7.11
402
- Wed, 08 Apr 2020 04:07:33 GMT
403
-
404
- _Version update only_
405
-
406
- ## 7.7.10
407
- Sat, 28 Mar 2020 00:37:16 GMT
408
-
409
- ### Patches
410
-
411
- - Upgrade to TSdoc 0.12.19
412
-
413
- ## 7.7.9
414
- Wed, 18 Mar 2020 15:07:47 GMT
415
-
416
- ### Patches
417
-
418
- - Upgrade cyclic dependencies
419
-
420
- ## 7.7.8
421
- Tue, 17 Mar 2020 23:55:58 GMT
422
-
423
- ### Patches
424
-
425
- - Replace dependencies whose NPM scope was renamed from `@microsoft` to `@rushstack`
426
-
427
- ## 7.7.7
428
- Tue, 28 Jan 2020 02:23:44 GMT
429
-
430
- _Version update only_
431
-
432
- ## 7.7.6
433
- Thu, 23 Jan 2020 01:07:56 GMT
434
-
435
- _Version update only_
436
-
437
- ## 7.7.5
438
- Tue, 21 Jan 2020 21:56:14 GMT
439
-
440
- _Version update only_
441
-
442
- ## 7.7.4
443
- Sun, 19 Jan 2020 02:26:52 GMT
444
-
445
- ### Patches
446
-
447
- - Upgrade Node typings to Node 10
448
-
449
- ## 7.7.3
450
- Fri, 17 Jan 2020 01:08:23 GMT
451
-
452
- _Version update only_
453
-
454
- ## 7.7.2
455
- Thu, 09 Jan 2020 06:44:13 GMT
456
-
457
- _Version update only_
458
-
459
- ## 7.7.1
460
- Wed, 08 Jan 2020 00:11:31 GMT
461
-
462
- _Version update only_
463
-
464
- ## 7.7.0
465
- Tue, 03 Dec 2019 03:17:43 GMT
466
-
467
- ### Minor changes
468
-
469
- - Improve declaration reference syntax to allow linking to overloaded functions/methods
470
-
471
- ## 7.6.0
472
- Sun, 24 Nov 2019 00:54:04 GMT
473
-
474
- ### Minor changes
475
-
476
- - Added support for `@throws`
477
-
478
- ## 7.5.6
479
- Fri, 15 Nov 2019 04:50:50 GMT
480
-
481
- _Version update only_
482
-
483
- ## 7.5.5
484
- Mon, 11 Nov 2019 16:07:56 GMT
485
-
486
- _Version update only_
487
-
488
- ## 7.5.4
489
- Tue, 05 Nov 2019 06:49:28 GMT
490
-
491
- ### Patches
492
-
493
- - Fix an issue where API reports sometimes were ordered differently depending on the version of NodeJS (GitHub #1552)
494
-
495
- ## 7.5.3
496
- Tue, 05 Nov 2019 01:08:39 GMT
497
-
498
- ### Patches
499
-
500
- - Clarified an error message
501
-
502
- ## 7.5.2
503
- Tue, 22 Oct 2019 06:24:44 GMT
504
-
505
- ### Patches
506
-
507
- - Refactor some code as part of migration from TSLint to ESLint
508
-
509
- ## 7.5.1
510
- Sun, 29 Sep 2019 23:56:29 GMT
511
-
512
- ### Patches
513
-
514
- - Update repository URL
515
-
516
- ## 7.5.0
517
- Wed, 25 Sep 2019 15:15:31 GMT
518
-
519
- ### Minor changes
520
-
521
- - Add ApiItem.getMergedSiblings() API
522
-
523
- ## 7.4.2
524
- Mon, 23 Sep 2019 15:14:55 GMT
525
-
526
- ### Patches
527
-
528
- - Remove unnecessary dependency on @types/node
529
-
530
- ## 7.4.1
531
- Tue, 10 Sep 2019 22:32:23 GMT
532
-
533
- ### Patches
534
-
535
- - Update documentation
536
-
537
- ## 7.4.0
538
- Tue, 10 Sep 2019 20:38:33 GMT
539
-
540
- ### Minor changes
541
-
542
- - Add 'canonicalReference' to ExcerptToken
543
-
544
- ## 7.3.4
545
- Wed, 04 Sep 2019 18:28:06 GMT
546
-
547
- _Version update only_
548
-
549
- ## 7.3.3
550
- Wed, 04 Sep 2019 15:15:37 GMT
551
-
552
- ### Patches
553
-
554
- - Update TSDoc dependency to 0.12.14
555
-
556
- ## 7.3.2
557
- Thu, 08 Aug 2019 15:14:17 GMT
558
-
559
- _Version update only_
560
-
561
- ## 7.3.1
562
- Thu, 08 Aug 2019 00:49:05 GMT
563
-
564
- ### Patches
565
-
566
- - (Experimental) Add ApiExtractor.canonicalReference which is a beta implementation of the revised TSDoc declaration reference notation
567
-
568
- ## 7.3.0
569
- Mon, 22 Jul 2019 19:13:10 GMT
570
-
571
- ### Minor changes
572
-
573
- - Rename `ApiItem.canonicalReference` to `.containerKey`; rename `ApiItemContainerMixin.tryGetMember()` to `.tryGetMemberByKey()`; rename `Api___.getCanonicalReference()` to `.getContainerKey()`
574
-
575
- ## 7.2.0
576
- Tue, 11 Jun 2019 00:48:06 GMT
577
-
578
- ### Minor changes
579
-
580
- - Add API support for type parameters and type alias types
581
-
582
- ### Patches
583
-
584
- - Improve the .api.json deserializer to validate the schema version and support backwards compatibility
585
-
586
- ## 7.1.3
587
- Wed, 05 Jun 2019 19:12:34 GMT
588
-
589
- ### Patches
590
-
591
- - Fix an issue where TSDoc index selectors (ApiParameterListMixin.overloadIndex) started from 0, whereas TSDoc requires a nonzero number
592
-
593
- ## 7.1.2
594
- Tue, 04 Jun 2019 05:51:53 GMT
595
-
596
- ### Patches
597
-
598
- - Fix an issue where ApiConstructor inherited from ApiStaticMixin, but TypeScript constructors cannot be static
599
-
600
- ## 7.1.1
601
- Mon, 27 May 2019 04:13:44 GMT
602
-
603
- ### Patches
604
-
605
- - Make the strings returned by ApiItem.displayName less verbose
606
- - Improve formatting of the strings returned by ApiItem.getScopedNameWithinPackage()
607
-
608
- ## 7.1.0
609
- Tue, 16 Apr 2019 11:01:37 GMT
610
-
611
- ### Minor changes
612
-
613
- - Initial stable release of API Extractor 7
614
-
615
- ## 7.0.28
616
- Wed, 20 Mar 2019 19:14:49 GMT
617
-
618
- _Version update only_
619
-
620
- ## 7.0.27
621
- Mon, 18 Mar 2019 04:28:43 GMT
622
-
623
- ### Patches
624
-
625
- - Add helper functions for ReleaseTag
626
- - Export IApiItemConstructor to eliminate the ae-forgotten-export warning
627
-
628
- ## 7.0.26
629
- Wed, 13 Mar 2019 19:13:14 GMT
630
-
631
- ### Patches
632
-
633
- - Refactor code to move the IndentedWriter API from api-extractor-model to api-documenter
634
-
635
- ## 7.0.25
636
- Wed, 13 Mar 2019 01:14:05 GMT
637
-
638
- ### Patches
639
-
640
- - Upgrade TSDoc
641
-
642
- ## 7.0.24
643
- Mon, 11 Mar 2019 16:13:36 GMT
644
-
645
- ### Patches
646
-
647
- - Initial setup of new package @microsoft/api-extractor-model
648
-