@microsoft/api-extractor-model 7.15.1 → 7.15.4

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