UNPKG

37.5 kBMarkdownView Raw
1# Change Log - @microsoft/api-extractor
2
3This log was last generated on Thu, 21 May 2020 15:41:59 GMT and should not be manually modified.
4
5## 7.8.3
6Thu, 21 May 2020 15:41:59 GMT
7
8*Version update only*
9
10## 7.8.2
11Tue, 19 May 2020 15:08:19 GMT
12
13### Patches
14
15- Report an error to indicate that "import()" types are not supported
16
17## 7.8.1
18Fri, 15 May 2020 08:10:59 GMT
19
20*Version update only*
21
22## 7.8.0
23Wed, 06 May 2020 08:23:45 GMT
24
25### Minor changes
26
27- Version update only
28
29## 7.7.13
30Wed, 08 Apr 2020 04:07:33 GMT
31
32*Version update only*
33
34## 7.7.12
35Sun, 29 Mar 2020 00:04:12 GMT
36
37### Patches
38
39- Improve analysis of types exposed via global variables (fixes GitHub issues #1765, #1095, and #1316)
40
41## 7.7.11
42Sat, 28 Mar 2020 00:37:16 GMT
43
44### Patches
45
46- Upgrade to TSdoc 0.12.19 to fix an issue where `<h1>` wasn't allowed as an HTML tag in a doc comment
47
48## 7.7.10
49Wed, 18 Mar 2020 15:07:47 GMT
50
51### Patches
52
53- Upgrade cyclic dependencies
54
55## 7.7.9
56Tue, 17 Mar 2020 23:55:58 GMT
57
58### Patches
59
60- Replace dependencies whose NPM scope was renamed from `@microsoft` to `@rushstack`
61
62## 7.7.8
63Tue, 28 Jan 2020 02:23:44 GMT
64
65*Version update only*
66
67## 7.7.7
68Thu, 23 Jan 2020 01:07:56 GMT
69
70*Version update only*
71
72## 7.7.6
73Tue, 21 Jan 2020 21:56:13 GMT
74
75*Version update only*
76
77## 7.7.5
78Sun, 19 Jan 2020 02:26:52 GMT
79
80### Patches
81
82- Upgrade Node typings to Node 10
83
84## 7.7.4
85Fri, 17 Jan 2020 01:08:23 GMT
86
87*Version update only*
88
89## 7.7.3
90Tue, 14 Jan 2020 01:34:15 GMT
91
92### Patches
93
94- Fix an issue where "ae-incompatible-release-tags" was sometimes reported incorectly for property setters (GitHub #1681)
95
96## 7.7.2
97Thu, 09 Jan 2020 06:44:12 GMT
98
99### Patches
100
101- Fix an error "Cannot read property 'externalModuleIndicator' of undefined" (GitHub #1652)
102
103## 7.7.1
104Wed, 08 Jan 2020 00:11:31 GMT
105
106*Version update only*
107
108## 7.7.0
109Tue, 03 Dec 2019 03:17:43 GMT
110
111### Minor changes
112
113- Improve declaration reference syntax to allow linking to overloaded functions/methods
114- Fix an issue with TypeScript 3.7, which now emits separate signatures for property getters/setters
115
116## 7.6.2
117Sun, 24 Nov 2019 00:54:04 GMT
118
119*Version update only*
120
121## 7.6.1
122Wed, 20 Nov 2019 06:14:28 GMT
123
124### Patches
125
126- Fix an issue where the newlineKind setting wasn't being applied correctly
127
128## 7.6.0
129Fri, 15 Nov 2019 04:50:50 GMT
130
131### Minor changes
132
133- Make newline type for generated files configurable
134
135## 7.5.6
136Mon, 11 Nov 2019 16:07:56 GMT
137
138*Version update only*
139
140## 7.5.5
141Wed, 06 Nov 2019 22:44:18 GMT
142
143### Patches
144
145- Add support for TypeScript 3.7
146
147## 7.5.4
148Tue, 05 Nov 2019 06:49:28 GMT
149
150### Patches
151
152- Fix an issue where API reports sometimes were ordered differently depending on the version of NodeJS (GitHub #1552)
153
154## 7.5.3
155Tue, 05 Nov 2019 01:08:39 GMT
156
157*Version update only*
158
159## 7.5.2
160Tue, 22 Oct 2019 06:24:44 GMT
161
162*Version update only*
163
164## 7.5.1
165Fri, 18 Oct 2019 15:15:01 GMT
166
167*Version update only*
168
169## 7.5.0
170Sun, 06 Oct 2019 00:27:39 GMT
171
172### Minor changes
173
174- Allow separate release tags for overloaded functions and methods
175- Add new api-extractor.json config setting "bundledPackages"
176
177## 7.4.7
178Fri, 04 Oct 2019 00:15:22 GMT
179
180### Patches
181
182- Fix an issue where IExtractorConfigPrepareOptions.packageJson was ignored (GitHub #1559)
183
184## 7.4.6
185Sun, 29 Sep 2019 23:56:29 GMT
186
187### Patches
188
189- Update repository URL
190
191## 7.4.5
192Wed, 25 Sep 2019 15:15:31 GMT
193
194*Version update only*
195
196## 7.4.4
197Tue, 24 Sep 2019 02:58:49 GMT
198
199*Version update only*
200
201## 7.4.3
202Mon, 23 Sep 2019 15:14:55 GMT
203
204*Version update only*
205
206## 7.4.2
207Wed, 11 Sep 2019 19:56:23 GMT
208
209### Patches
210
211- Add support for an exported name that conflicts with a global name (GitHub #1350)
212
213## 7.4.1
214Tue, 10 Sep 2019 22:32:23 GMT
215
216### Patches
217
218- Update documentation
219
220## 7.4.0
221Tue, 10 Sep 2019 20:38:33 GMT
222
223### Minor changes
224
225- Add support for generating declaration references
226
227## 7.3.11
228Wed, 04 Sep 2019 18:28:06 GMT
229
230*Version update only*
231
232## 7.3.10
233Wed, 04 Sep 2019 15:15:37 GMT
234
235### Patches
236
237- Update TSDoc dependency to 0.12.14
238
239## 7.3.9
240Fri, 30 Aug 2019 00:14:32 GMT
241
242### Patches
243
244- Fix a problem where Unicode API names were not handled correctly
245
246## 7.3.8
247Mon, 12 Aug 2019 15:15:14 GMT
248
249*Version update only*
250
251## 7.3.7
252Thu, 08 Aug 2019 15:14:17 GMT
253
254*Version update only*
255
256## 7.3.6
257Thu, 08 Aug 2019 00:49:05 GMT
258
259### Patches
260
261- Fix an issue where a function with only one declaration was assigned an overloadIndex of 0 instead of 1
262
263## 7.3.5
264Mon, 05 Aug 2019 22:04:32 GMT
265
266### Patches
267
268- Security updates.
269
270## 7.3.4
271Tue, 23 Jul 2019 01:13:01 GMT
272
273### Patches
274
275- ApiItem.name is now quoted when it contains invalid identifier characters, to avoid conflicts with an ECMAScript symbol expression
276
277## 7.3.3
278Mon, 22 Jul 2019 19:13:10 GMT
279
280### Patches
281
282- Update to use new api-extractor-model
283
284## 7.3.2
285Fri, 12 Jul 2019 19:12:46 GMT
286
287### Patches
288
289- Clarify docs for "--typescript-compiler-folder"
290
291## 7.3.1
292Thu, 11 Jul 2019 19:13:08 GMT
293
294### Patches
295
296- Add support for TypeScript 3.5
297
298## 7.3.0
299Tue, 09 Jul 2019 19:13:24 GMT
300
301### Minor changes
302
303- Add a "--diagnostics" command-line option to help when troubleshooting problems
304
305## 7.2.3
306Mon, 08 Jul 2019 19:12:18 GMT
307
308### Patches
309
310- Fix a problem when analyzing .d.ts files that appear in the same folder as the corresponding .ts file (GitHub #1310)
311
312## 7.2.2
313Sat, 29 Jun 2019 02:30:10 GMT
314
315### Patches
316
317- Fix GitHub issue #1304 where "IExtractorInvokeOptions.typescriptCompilerFolder" did not work with TypeScript 3.4
318
319## 7.2.1
320Wed, 12 Jun 2019 19:12:33 GMT
321
322*Version update only*
323
324## 7.2.0
325Tue, 11 Jun 2019 00:48:06 GMT
326
327### Minor changes
328
329- Generate ApiTypeParameter entries and type alias types
330
331## 7.1.8
332Wed, 05 Jun 2019 19:12:34 GMT
333
334### Patches
335
336- Fix an issue where TSDoc index selectors (ApiParameterListMixin.overloadIndex) started from 0, whereas TSDoc requires a nonzero number
337
338## 7.1.7
339Tue, 04 Jun 2019 05:51:53 GMT
340
341### Patches
342
343- Upgrade api-extractor-model to remove ApiConstructor.isStatic, since TypeScript constructors cannot be static
344- Improve handling of symbolic property and method names.
345
346## 7.1.6
347Mon, 27 May 2019 04:13:44 GMT
348
349### Patches
350
351- Fix incorrect path resolution for the "extends" field when loading tsconfig.json
352
353## 7.1.5
354Mon, 13 May 2019 02:08:35 GMT
355
356### Patches
357
358- Broaden support for default imports
359
360## 7.1.4
361Mon, 06 May 2019 20:46:21 GMT
362
363*Version update only*
364
365## 7.1.3
366Mon, 06 May 2019 19:34:54 GMT
367
368### Patches
369
370- Add a new setting "omitTrimmingComments" to prevent extra comments from being emitted in the .d.ts rollup
371
372## 7.1.2
373Mon, 06 May 2019 19:11:16 GMT
374
375### Patches
376
377- Fix an issue where ExtractorResult.warningCount was not incremented for messages handled by IExtractorInvokeOptions.messageCallback (GitHub #1258)
378
379## 7.1.1
380Tue, 30 Apr 2019 23:08:02 GMT
381
382### Patches
383
384- Fix an issue where API signatures were sometimes truncated in the .api.json file (GitHub #1249)
385
386## 7.1.0
387Tue, 16 Apr 2019 11:01:37 GMT
388
389### Minor changes
390
391- Initial stable release of API Extractor 7
392
393## 7.0.42
394Fri, 12 Apr 2019 06:13:16 GMT
395
396### Patches
397
398- Fix a regression that prevented certain types of warnings from being reported
399
400## 7.0.41
401Thu, 11 Apr 2019 07:14:01 GMT
402
403### Patches
404
405- THIS IS A RELEASE CANDIDATE FOR API-EXTRACTOR 7
406- (Breaking change) Rename "mainEntryPointFile" to "mainEntryPointFilePath" so all settings use a consistent naming convention
407- (Breaking change) Paths that appear in api-extractor.json are now resolved relative to the config file unless prefixed with the `<projectFolder>` token
408- Add a new api-extractor.json setting "tsconfigFilePath" for customizing the tsconfig.json path
409- Replace ExtractorConfig.packageJsonFullPath with ExtractorConfig.packageFolder
410- Upgrade API Extractor to use TypeScript 3.4 for analysis
411
412## 7.0.40
413Tue, 09 Apr 2019 05:31:01 GMT
414
415### Patches
416
417- Improve the "--local" option to automatically create the API report file if it is missing
418
419## 7.0.39
420Mon, 08 Apr 2019 19:12:52 GMT
421
422### Patches
423
424- Rename "addToApiReviewFile" setting to "addToApiReportFile"
425
426## 7.0.38
427Sat, 06 Apr 2019 02:05:51 GMT
428
429### Patches
430
431- (Breaking change) Removed the ILogger API and renamed ExtractorMessageLogLevel to ExtractorLogLevel
432- (Breaking change) Extractor console output is now modeled as ExtractorMessage objects and can be customized/filtered/handled by IExtractorInvokeOptions.messageCallback
433
434## 7.0.37
435Fri, 05 Apr 2019 04:16:16 GMT
436
437### Patches
438
439- Introduce "api-extractor init" command-line that helps enable API Extractor for a new project
440- (Breaking change) Major redesign of the API used to invoke API Extractor
441- (Breaking change) Major redesign of the api-extractor.json config file format
442- Add a CompilerState API that allows an optimization where multiple invocations of Extractor can reuse the same TypeScript compiler analysis
443
444## 7.0.36
445Wed, 03 Apr 2019 02:58:33 GMT
446
447### Patches
448
449- Fix an issue where .d.ts.map file were sometimes mapped to the wrong location
450
451## 7.0.35
452Sat, 30 Mar 2019 22:27:16 GMT
453
454### Patches
455
456- Reintroduce the generated documentation notice for internal constructors
457- Add limited support for resolving @inheritDoc references to external packages by postprocessing them in api-documenter
458
459## 7.0.34
460Thu, 28 Mar 2019 19:14:27 GMT
461
462### Patches
463
464- Validate `@link` tags and report a warning if the link cannot be resolved
465
466## 7.0.33
467Tue, 26 Mar 2019 20:54:18 GMT
468
469### Patches
470
471- Reintroduce support for `@inheritDoc` tags
472
473## 7.0.32
474Sat, 23 Mar 2019 03:48:31 GMT
475
476### Patches
477
478- If the TSDoc summary is missing for a class constructor, then automatically generate it
479- Reintroduce support for the `@preapproved` TSDoc tag
480
481## 7.0.31
482Thu, 21 Mar 2019 04:59:11 GMT
483
484### Patches
485
486- Reintroduce "ae-internal-missing-underscore" warning for API items marked as `@internal` but whose name does not start with an underscore
487
488## 7.0.30
489Thu, 21 Mar 2019 01:15:32 GMT
490
491### Patches
492
493- Improve the API review file generation to include imports and support multiple exports
494
495## 7.0.29
496Wed, 20 Mar 2019 19:14:49 GMT
497
498### Patches
499
500- API Extractor can now analyze packages whose package.json file is missing the "version" field
501
502## 7.0.28
503Mon, 18 Mar 2019 04:28:43 GMT
504
505### Patches
506
507- Rename the "ae-inconsistent-release-tags" warning to "ae-different-release-tags"
508- Introduce a new warning "ae-incompatible-release-tags" that checks for API signatures that reference types with incompatible release tags
509- Fix an issue where this error was sometimes reported incorrectly: "The messages.extractorMessageReporting table contains an unrecognized identifier ___"
510
511## 7.0.27
512Fri, 15 Mar 2019 19:13:25 GMT
513
514### Patches
515
516- (Breaking change) The file extension for API review files has changed from ".api.ts" to "api.md". For details see https://github.com/Microsoft/web-build-tools/issues/1123
517
518## 7.0.26
519Wed, 13 Mar 2019 19:13:14 GMT
520
521### Patches
522
523- Refactor code to move the IndentedWriter API from api-extractor-model to api-documenter
524
525## 7.0.25
526Wed, 13 Mar 2019 01:14:05 GMT
527
528### Patches
529
530- Upgrade TSDoc
531
532## 7.0.24
533Mon, 11 Mar 2019 16:13:36 GMT
534
535### Patches
536
537- Fix an issue where spurious TSDoc warnings were issued because the TSDoc parser was configured improperly
538- Move the .api.json related APIs into a new NPM package @microsoft/api-extractor-model
539
540## 7.0.23
541Tue, 05 Mar 2019 17:13:11 GMT
542
543### Patches
544
545- Issue a warning when an exported type refers to another local type that is not exported (ae-forgotten-export)
546- The export analyzer now correctly handles symbols imported using "import x = require('y');" notation
547
548## 7.0.22
549Mon, 04 Mar 2019 17:13:19 GMT
550
551### Patches
552
553- Every error/warning message reported by API Extractor now has an associated message identifier
554- Add a new section to api-extractor.json for configuring how errors get reported, with ability to suppress individual errors
555- Reintroduce the ability to report issues by writing warnings into the API review file
556- Fix an issue where members of type literals were incorrectly being flagged as "(undocumented)"
557- Error messages now cite the original .ts source file, if a source map is present. (To enable this, specify `"declarationMap": true` in tsconfig.json.)
558
559## 7.0.21
560Wed, 27 Feb 2019 22:13:58 GMT
561
562*Version update only*
563
564## 7.0.20
565Wed, 27 Feb 2019 17:13:17 GMT
566
567*Version update only*
568
569## 7.0.19
570Mon, 18 Feb 2019 17:13:23 GMT
571
572### Minor changes
573
574- New way to resolve & generate TSDoc metadata file
575
576## 7.0.18
577Tue, 12 Feb 2019 17:13:12 GMT
578
579### Patches
580
581- Add a workaround for the issue where .d.ts rollups sometimes define names that conflict with a global symbol (the full solution is tracked by GitHub #1095)
582
583## 7.0.17
584Mon, 11 Feb 2019 10:32:37 GMT
585
586### Patches
587
588- Fix an issue where API Extractor neglected to analyze "typeof" expressions
589- Fix an issue where declarations inside a namespace were sometimes being incorrectly emitted as top-level exports of the .d.ts rollup
590
591## 7.0.16
592Mon, 11 Feb 2019 08:55:57 GMT
593
594### Patches
595
596- Redesign the analyzer so that when an external symbol is reexported by the working package, the local object (AstImport) and external object (AstSymbol) are kept separate
597- Fix a number of bugs where external symbols were misinterpreted as being part of the local project
598- Eliminate a number of errors involving unusual language constructs, by avoiding analysis of external symbols unless it's really necessary
599- Simplify the AstSymbol.nominalAnalysis concept and associated code
600- Improve .d.ts rollup trimming to handle reexported symbols correctly
601
602## 7.0.15
603Mon, 11 Feb 2019 03:31:55 GMT
604
605### Patches
606
607- The `--debug` parameter now automatically breaks in the debugger when InternalError is thrown
608
609## 7.0.14
610Thu, 31 Jan 2019 17:03:49 GMT
611
612### Patches
613
614- Upgrade to TSDoc 0.12.5, which allows `$` in `@param` names
615- Add "testMode" option in api-extractor.json to eliminate spurious diffs in test files when the version number gets bumped
616- Normalize newlines for excerpt strings in the .api.json file
617
618## 7.0.13
619Sat, 19 Jan 2019 03:47:47 GMT
620
621### Patches
622
623- Move the skipLibCheck into the config file.
624
625## 7.0.12
626Sat, 19 Jan 2019 01:17:51 GMT
627
628### Patches
629
630- Fix an issue where files using "export=" were incorrectly interpreted as having ambient declarations
631
632## 7.0.11
633Fri, 18 Jan 2019 00:52:21 GMT
634
635### Patches
636
637- Add support for circular references between files that use `export * from "____";`
638
639## 7.0.10
640Thu, 17 Jan 2019 00:37:54 GMT
641
642### Patches
643
644- Add support for exports of the form `export * from "____";`
645- Improve the analyzer to allow a declaration to be exported more than once
646- Fix inconsistent newlines in .api.ts files
647
648## 7.0.9
649Thu, 10 Jan 2019 01:57:52 GMT
650
651### Patches
652
653- Fix an issue with rolling up default exports (https://github.com/Microsoft/web-build-tools/issues/1007)
654
655## 7.0.8
656Thu, 20 Dec 2018 17:04:08 GMT
657
658### Patches
659
660- Fix an issue where it was possible to import forgotten declarations from a .d.ts rollup, even though they did not have an explicit "export" modifier
661
662## 7.0.7
663Wed, 19 Dec 2018 05:57:33 GMT
664
665### Patches
666
667- Extend ApiModel to support new item kinds: ApiCallSignature, ApiConstructor, ApiConstructSignature, ApiFunction, ApiIndexSignature, ApiTypeAlias, and ApiVariable
668
669## 7.0.6
670Fri, 14 Dec 2018 19:43:46 GMT
671
672### Patches
673
674- Update web site URLs
675
676## 7.0.5
677Thu, 13 Dec 2018 02:58:10 GMT
678
679### Patches
680
681- Remove unused jju dependency
682
683## 7.0.4
684Wed, 12 Dec 2018 17:04:19 GMT
685
686### Patches
687
688- Reintroduce support for "extends" and "implements" heritage clauses
689- Redesign the Excerpt API to support multiple subranges (e.g. for a list of "implements" clauses)
690
691## 7.0.3
692Fri, 07 Dec 2018 17:04:56 GMT
693
694### Patches
695
696- Added more API documentation
697
698## 7.0.2
699Wed, 05 Dec 2018 19:57:03 GMT
700
701### Patches
702
703- fix reexported types from an external package for dts rollup
704
705## 7.0.1
706Wed, 05 Dec 2018 17:04:18 GMT
707
708### Patches
709
710- Fix an issue where .d.ts trimming did not properly handle variable declarations (GitHub #976)
711
712## 7.0.0
713Thu, 29 Nov 2018 07:02:09 GMT
714
715### Breaking changes
716
717- THIS IS A BETA RELEASE - We are bumping the version to "7.0.0" to simplify dogfooding. This release is not yet ready for general usage.
718
719## 6.3.0
720Wed, 28 Nov 2018 19:29:53 GMT
721
722### Minor changes
723
724- Support "extends" field in api-extractor.json config files for easier management of monorepos with many projects
725
726## 6.2.0
727Wed, 28 Nov 2018 02:17:11 GMT
728
729### Minor changes
730
731- Introduce a new build output "dist/tsdoc-metdata.json", which completely replaces the old "tsdocFlavor" field in package.json
732
733## 6.1.6
734Fri, 16 Nov 2018 21:37:10 GMT
735
736### Patches
737
738- Add support for emitting `/// <reference lib="___" />` directives in .d.ts rollups (GitHub issue #946)
739
740## 6.1.5
741Fri, 16 Nov 2018 00:59:00 GMT
742
743### Patches
744
745- Fix an issue where .d.ts trimming did not work for exported variable declarations (GitHub #936)
746
747## 6.1.4
748Fri, 09 Nov 2018 23:07:39 GMT
749
750### Patches
751
752- Upgrade to TSDoc 0.21.2, which improves trimming of link text in `@link` tags
753
754## 6.1.3
755Wed, 07 Nov 2018 21:04:35 GMT
756
757*Version update only*
758
759## 6.1.2
760Mon, 05 Nov 2018 17:04:24 GMT
761
762### Patches
763
764- Upgrade to @microsoft/tsdoc 0.12.0
765
766## 6.1.1
767Thu, 01 Nov 2018 19:32:52 GMT
768
769### Patches
770
771- Fix an issue where EcmaScript symbols ("computed property names") were missing from .d.ts rollups
772
773## 6.1.0
774Wed, 31 Oct 2018 17:00:54 GMT
775
776### Minor changes
777
778- Added an api to invoke api extractor processor by supplying api extractor json config file.
779
780## 6.0.9
781Thu, 25 Oct 2018 23:20:40 GMT
782
783*Version update only*
784
785## 6.0.8
786Thu, 25 Oct 2018 08:56:02 GMT
787
788### Patches
789
790- Fix issue where `DocErrorText.text` returned `[object Object]` instead of the text
791
792## 6.0.7
793Wed, 24 Oct 2018 16:03:10 GMT
794
795*Version update only*
796
797## 6.0.6
798Thu, 18 Oct 2018 01:32:20 GMT
799
800### Patches
801
802- Fix isAbsolute check for mainDtsRollupPath
803
804## 6.0.5
805Wed, 17 Oct 2018 21:04:49 GMT
806
807*Version update only*
808
809## 6.0.4
810Wed, 17 Oct 2018 14:43:24 GMT
811
812### Patches
813
814- Fix a regression where namespaces were sometimes incorrectly handled in "conservative" mode
815- Update the command line to look for api-extractor.json in both the "./config" folder and the project folder
816- Allow type references in namespaces when namespaceSupport=conservative
817
818## 6.0.3
819Thu, 11 Oct 2018 23:26:07 GMT
820
821### Patches
822
823- Fix an issue where `import x from "."` was sometimes not processed correctly
824
825## 6.0.2
826Tue, 09 Oct 2018 06:58:01 GMT
827
828### Patches
829
830- Fix a regression where API Extractor was sometimes reporting incorrect line numbers
831
832## 6.0.1
833Mon, 08 Oct 2018 16:04:27 GMT
834
835*Version update only*
836
837## 6.0.0
838Sun, 07 Oct 2018 06:15:56 GMT
839
840### Breaking changes
841
842- (Breaking change) API Extractor 6 introduces support for TSDoc doc comment syntax! Please see https://api-extractor.com/ for documentation. To learn more about the TSDoc standard, check out https://github.com/Microsoft/tsdoc
843
844## 5.13.1
845Fri, 28 Sep 2018 16:05:35 GMT
846
847*Version update only*
848
849## 5.13.0
850Wed, 26 Sep 2018 21:39:40 GMT
851
852### Minor changes
853
854- Add new command line option --skip-lib-check
855
856## 5.12.2
857Mon, 24 Sep 2018 23:06:40 GMT
858
859### Patches
860
861- Allow doc comments to use TSDoc's "@defaultvalue" tag (but the value is not yet passed to the documentation pipeline)
862
863## 5.12.1
864Fri, 21 Sep 2018 16:04:42 GMT
865
866### Patches
867
868- Fix an issue where TypeScript errors are often logged as "[Object object]" instead of the actual error message.
869
870## 5.12.0
871Thu, 20 Sep 2018 23:57:21 GMT
872
873### Minor changes
874
875- Add new feature: Support using a different version of the TypeScript compiler.
876
877## 5.11.2
878Tue, 18 Sep 2018 21:04:55 GMT
879
880### Patches
881
882- Fix an issue where parameters mentioned in comments were attempting to be analyzed by api-extractor.
883
884## 5.11.1
885Thu, 06 Sep 2018 01:25:25 GMT
886
887### Patches
888
889- Update "repository" field in package.json
890
891## 5.11.0
892Mon, 03 Sep 2018 16:04:45 GMT
893
894### Minor changes
895
896- Upgrade api-extractor to internally use TypeScript 3.0.
897
898## 5.10.8
899Wed, 29 Aug 2018 06:36:50 GMT
900
901*Version update only*
902
903## 5.10.7
904Thu, 23 Aug 2018 18:18:53 GMT
905
906### Patches
907
908- Republish all packages in web-build-tools to resolve GitHub issue #782
909
910## 5.10.6
911Wed, 22 Aug 2018 20:58:58 GMT
912
913*Version update only*
914
915## 5.10.5
916Wed, 22 Aug 2018 16:03:25 GMT
917
918*Version update only*
919
920## 5.10.4
921Tue, 21 Aug 2018 16:04:38 GMT
922
923### Patches
924
925- fix namespace name for export statement`
926
927## 5.10.3
928Thu, 09 Aug 2018 21:03:22 GMT
929
930*Version update only*
931
932## 5.10.2
933Thu, 09 Aug 2018 16:04:24 GMT
934
935### Patches
936
937- Update lodash.
938
939## 5.10.1
940Thu, 26 Jul 2018 16:04:17 GMT
941
942*Version update only*
943
944## 5.10.0
945Tue, 17 Jul 2018 16:02:52 GMT
946
947### Minor changes
948
949- Add support for new "@eventproperty" AEDoc tag, which indicates that a class/interface property should be documented as an event
950
951## 5.9.1
952Tue, 03 Jul 2018 21:03:31 GMT
953
954*Version update only*
955
956## 5.9.0
957Sat, 23 Jun 2018 02:21:20 GMT
958
959### Minor changes
960
961- Add new IMarkupHtmlTag API
962- AEDoc now allows HTML tags inside doc comments, which can be disabled using a backslash escape
963
964## 5.8.1
965Thu, 21 Jun 2018 08:27:29 GMT
966
967*Version update only*
968
969## 5.8.0
970Tue, 19 Jun 2018 19:35:11 GMT
971
972### Minor changes
973
974- For namespaceSupport=permissive, allow arbitrary nesting of namespaces
975
976### Patches
977
978- Fix an issue where multi-line type literals sometimes had inconsistent newlines in the *.api.json file
979
980## 5.7.3
981Fri, 08 Jun 2018 08:43:52 GMT
982
983*Version update only*
984
985## 5.7.2
986Thu, 31 May 2018 01:39:33 GMT
987
988*Version update only*
989
990## 5.7.1
991Tue, 15 May 2018 02:26:45 GMT
992
993*Version update only*
994
995## 5.7.0
996Tue, 15 May 2018 00:18:10 GMT
997
998### Minor changes
999
1000- Add support for new AEDoc tags @sealed, @virtual, and @override
1001
1002## 5.6.8
1003Fri, 04 May 2018 00:42:38 GMT
1004
1005### Patches
1006
1007- Fix the formatting of a log message.
1008
1009## 5.6.7
1010Tue, 01 May 2018 22:03:20 GMT
1011
1012### Patches
1013
1014- Fix an issue where the *.d.ts rollup trimming did not trim import statements
1015
1016## 5.6.6
1017Fri, 27 Apr 2018 03:04:32 GMT
1018
1019*Version update only*
1020
1021## 5.6.5
1022Thu, 19 Apr 2018 21:25:56 GMT
1023
1024*Version update only*
1025
1026## 5.6.4
1027Thu, 19 Apr 2018 17:02:06 GMT
1028
1029### Patches
1030
1031- Fix errors in schema documentation
1032
1033## 5.6.3
1034Tue, 03 Apr 2018 16:05:29 GMT
1035
1036*Version update only*
1037
1038## 5.6.2
1039Mon, 02 Apr 2018 16:05:24 GMT
1040
1041### Patches
1042
1043- Refactor to use new @microsoft/node-core-library
1044
1045## 5.6.1
1046Tue, 27 Mar 2018 01:34:25 GMT
1047
1048### Patches
1049
1050- Update build config so API Extractor builds using the latest version of itself
1051
1052## 5.6.0
1053Sun, 25 Mar 2018 01:26:19 GMT
1054
1055### Minor changes
1056
1057- Improve the api-extractor.json config file so that *.d.ts rollups go in separate folders, and trimming can now be disabled
1058
1059### Patches
1060
1061- In preparation for initial release, the "Package Typings" feature was renamed to "DTS Rollup"
1062- Fix an issue where the @packagedocumentation comment was sometimes getting mixed into the middle of the rollup *.d.ts file
1063
1064## 5.5.2
1065Fri, 23 Mar 2018 00:34:53 GMT
1066
1067### Patches
1068
1069- Upgrade colors to version ~1.2.1
1070
1071## 5.5.1
1072Tue, 20 Mar 2018 02:44:45 GMT
1073
1074### Patches
1075
1076- Improve packageTypings generator to trim nested members according to their release tag
1077- Fix a bug where packageTypings failed to handle merged declarations properly
1078
1079## 5.5.0
1080Sat, 17 Mar 2018 02:54:22 GMT
1081
1082### Minor changes
1083
1084- Overhaul the packageTypings generator analysis to get ready for the upcoming nested member trimming
1085- Breaking change: Any projects using the package typings feature must now have a "tsdoc" section in their package.json
1086
1087### Patches
1088
1089- Add "--debug" flag for debugging
1090
1091## 5.4.0
1092Thu, 15 Mar 2018 20:00:50 GMT
1093
1094### Minor changes
1095
1096- Add a new setting validationRules.missingReleaseTags to optionally remove the requirement that every API item should have a release tag
1097- Add new API "Markup.formatApiItemReference()"
1098
1099### Patches
1100
1101- Fix an issue where the automatically generated documentation for class constructors sometimes had a broken hyperlink
1102
1103## 5.3.9
1104Thu, 15 Mar 2018 16:05:43 GMT
1105
1106*Version update only*
1107
1108## 5.3.8
1109Mon, 12 Mar 2018 20:36:19 GMT
1110
1111### Patches
1112
1113- Locked down some "@types/" dependency versions to avoid upgrade conflicts
1114
1115## 5.3.7
1116Tue, 06 Mar 2018 17:04:51 GMT
1117
1118### Patches
1119
1120- Add preliminary support for preview and public outputs for packageTypings generator
1121
1122## 5.3.6
1123Fri, 02 Mar 2018 01:13:59 GMT
1124
1125*Version update only*
1126
1127## 5.3.5
1128Tue, 27 Feb 2018 22:05:57 GMT
1129
1130*Version update only*
1131
1132## 5.3.4
1133Wed, 21 Feb 2018 22:04:19 GMT
1134
1135*Version update only*
1136
1137## 5.3.3
1138Wed, 21 Feb 2018 03:13:28 GMT
1139
1140*Version update only*
1141
1142## 5.3.2
1143Sat, 17 Feb 2018 02:53:49 GMT
1144
1145### Patches
1146
1147- Fix several bugs with the way that imports were being deduplicated by the packageTypings feature
1148
1149## 5.3.1
1150Fri, 16 Feb 2018 22:05:23 GMT
1151
1152*Version update only*
1153
1154## 5.3.0
1155Fri, 16 Feb 2018 17:05:11 GMT
1156
1157### Minor changes
1158
1159- Fix an issue where the packageTypings feature didn't handle some import/export patterns
1160
1161### Patches
1162
1163- Fix an issue where the packageTypings feature sometimes emitted "default" instead of the class name
1164- Improve the packageTypings feature to support triple-slash references to typings
1165
1166## 5.2.7
1167Wed, 07 Feb 2018 17:05:11 GMT
1168
1169*Version update only*
1170
1171## 5.2.6
1172Fri, 26 Jan 2018 22:05:30 GMT
1173
1174*Version update only*
1175
1176## 5.2.5
1177Fri, 26 Jan 2018 17:53:38 GMT
1178
1179### Patches
1180
1181- Force a patch bump in case the previous version was an empty package
1182
1183## 5.2.4
1184Fri, 26 Jan 2018 00:36:51 GMT
1185
1186*Version update only*
1187
1188## 5.2.3
1189Tue, 23 Jan 2018 17:05:28 GMT
1190
1191*Version update only*
1192
1193## 5.2.2
1194Thu, 18 Jan 2018 03:23:46 GMT
1195
1196### Patches
1197
1198- Enable package typings generated by api-extractor
1199
1200## 5.2.1
1201Thu, 18 Jan 2018 00:48:06 GMT
1202
1203*Version update only*
1204
1205## 5.2.0
1206Thu, 18 Jan 2018 00:27:23 GMT
1207
1208### Minor changes
1209
1210- Improve the packageTypings feature to support abstract classes and "import * as X" imports
1211
1212## 5.1.3
1213Wed, 17 Jan 2018 10:49:31 GMT
1214
1215*Version update only*
1216
1217## 5.1.2
1218Fri, 12 Jan 2018 03:35:22 GMT
1219
1220### Patches
1221
1222- Add some incremental improvements for the experimental PackageTypingsGenerator feature
1223
1224## 5.1.1
1225Thu, 11 Jan 2018 22:31:51 GMT
1226
1227*Version update only*
1228
1229## 5.1.0
1230Wed, 10 Jan 2018 20:40:01 GMT
1231
1232### Minor changes
1233
1234- Upgrade to Node 8
1235
1236### Patches
1237
1238- Continued progress for the experimental PackageTypingsGenerator
1239
1240## 5.0.1
1241Tue, 09 Jan 2018 17:05:51 GMT
1242
1243### Patches
1244
1245- Get web-build-tools building with pnpm
1246
1247## 5.0.0
1248Sun, 07 Jan 2018 05:12:08 GMT
1249
1250### Breaking changes
1251
1252- API Extractor now processes *.d.ts files instead of *.ts files
1253
1254### Minor changes
1255
1256- Introduced new tag @packagedocumentation which replaces the earlier approach that used a "packageDescription" variable
1257
1258## 4.3.7
1259Fri, 05 Jan 2018 20:26:45 GMT
1260
1261*Version update only*
1262
1263## 4.3.6
1264Fri, 05 Jan 2018 00:48:41 GMT
1265
1266### Patches
1267
1268- Update Jest to ~21.2.1
1269
1270## 4.3.5
1271Fri, 22 Dec 2017 17:04:46 GMT
1272
1273### Patches
1274
1275- Fixed an issue where warnings would cause the api-extractor tool to return a nonzero exit code for a "--local" build; warnings should not fail the build in this scenario
1276
1277## 4.3.4
1278Tue, 12 Dec 2017 03:33:26 GMT
1279
1280*Version update only*
1281
1282## 4.3.3
1283Thu, 30 Nov 2017 23:59:09 GMT
1284
1285*Version update only*
1286
1287## 4.3.2
1288Thu, 30 Nov 2017 23:12:21 GMT
1289
1290*Version update only*
1291
1292## 4.3.1
1293Wed, 29 Nov 2017 17:05:37 GMT
1294
1295*Version update only*
1296
1297## 4.3.0
1298Tue, 28 Nov 2017 23:43:55 GMT
1299
1300### Minor changes
1301
1302- Add Extractor.processProject() whose return value indicates success
1303
1304### Patches
1305
1306- Deprecate Extractor.analyzeProject() API
1307
1308## 4.2.6
1309Mon, 13 Nov 2017 17:04:50 GMT
1310
1311*Version update only*
1312
1313## 4.2.5
1314Mon, 06 Nov 2017 17:04:18 GMT
1315
1316*Version update only*
1317
1318## 4.2.4
1319Thu, 02 Nov 2017 16:05:24 GMT
1320
1321### Patches
1322
1323- lock the reference version between web build tools projects
1324
1325## 4.2.3
1326Wed, 01 Nov 2017 21:06:08 GMT
1327
1328### Patches
1329
1330- Upgrade cyclic dependencies
1331
1332## 4.2.2
1333Tue, 31 Oct 2017 21:04:04 GMT
1334
1335*Version update only*
1336
1337## 4.2.1
1338Tue, 31 Oct 2017 16:04:55 GMT
1339
1340*Version update only*
1341
1342## 4.2.0
1343Wed, 25 Oct 2017 20:03:59 GMT
1344
1345### Minor changes
1346
1347- Improved the way API JSON represents documentation markup; this is a file format change
1348
1349## 4.1.2
1350Tue, 24 Oct 2017 18:17:12 GMT
1351
1352*Version update only*
1353
1354## 4.1.1
1355Mon, 23 Oct 2017 21:53:12 GMT
1356
1357### Patches
1358
1359- Updated cyclic dependencies
1360
1361## 4.1.0
1362Fri, 20 Oct 2017 19:57:12 GMT
1363
1364### Minor changes
1365
1366- Add policies.namespaceSupport option to API Extractor config
1367
1368### Patches
1369
1370- Fixed an issue where properties were sometimes marked as readonly; a remark is automatically generated for classes with internal constructors
1371
1372## 4.0.1
1373Fri, 20 Oct 2017 01:52:54 GMT
1374
1375### Patches
1376
1377- Rename ApiExtractor class to Extractor
1378
1379## 4.0.0
1380Fri, 20 Oct 2017 01:04:44 GMT
1381
1382### Breaking changes
1383
1384- Redesigned interface for invoking API Extractor
1385
1386## 3.4.2
1387Thu, 05 Oct 2017 01:05:02 GMT
1388
1389*Version update only*
1390
1391## 3.4.1
1392Fri, 29 Sep 2017 01:03:42 GMT
1393
1394### Patches
1395
1396- Removed IMarkupPage.docId
1397
1398## 3.4.0
1399Thu, 28 Sep 2017 01:04:28 GMT
1400
1401### Minor changes
1402
1403- Skipping two lines in an AEDoc comment now creates a paragraph separator for the generated documentation
1404
1405### Patches
1406
1407- The *.api.json "linkDocElement" type now always explicitly specifies the package name, rather than expecting the reader to infer it
1408- The *.api.json file format now exposes "signature" information for properties, functions, and module variables
1409
1410## 3.3.0
1411Fri, 22 Sep 2017 01:04:02 GMT
1412
1413### Minor changes
1414
1415- Upgrade to es6
1416
1417## 3.2.6
1418Wed, 20 Sep 2017 22:10:17 GMT
1419
1420*Version update only*
1421
1422## 3.2.5
1423Mon, 11 Sep 2017 13:04:55 GMT
1424
1425### Patches
1426
1427- The isBeta and deprecatedMessage fields are now inherited in the *.api.json files
1428- Fix an issue where the *.api.json file was sometimes missing function parameters
1429
1430## 3.2.4
1431Fri, 08 Sep 2017 01:28:04 GMT
1432
1433### Patches
1434
1435- Deprecate @types/es6-coll ections in favor of built-in typescript typings 'es2015.collection' a nd 'es2015.iterable'
1436
1437## 3.2.3
1438Thu, 07 Sep 2017 13:04:35 GMT
1439
1440### Patches
1441
1442- Fix incorrect schema/typings for enum members
1443
1444## 3.2.2
1445Thu, 07 Sep 2017 00:11:11 GMT
1446
1447### Patches
1448
1449- Add $schema field to all schemas
1450
1451## 3.2.1
1452Wed, 06 Sep 2017 13:03:42 GMT
1453
1454### Patches
1455
1456- Converted IMarkupDocumentationLink to IMarkupApiLink, which exposes the underlying IApiItemReference rather than assuming a particular "document ID" model
1457
1458## 3.2.0
1459Tue, 05 Sep 2017 19:03:56 GMT
1460
1461### Minor changes
1462
1463- Add the constructor signature and package name to the exported API signature
1464
1465## 3.1.0
1466Sat, 02 Sep 2017 01:04:26 GMT
1467
1468### Minor changes
1469
1470- Expanded the api-extractor API to expose interfaces for the *.api.json file fileformat
1471
1472## 3.0.0
1473Thu, 31 Aug 2017 18:41:18 GMT
1474
1475### Breaking changes
1476
1477- Fix compatibility issues with old releases, by incrementing the major version number
1478
1479## 2.3.7
1480Thu, 31 Aug 2017 17:46:25 GMT
1481
1482### Patches
1483
1484- Fix issue where node-core-library was not an explicit dependency
1485
1486## 2.3.6
1487Wed, 30 Aug 2017 01:04:34 GMT
1488
1489*Version update only*
1490
1491## 2.3.5
1492Thu, 24 Aug 2017 22:44:12 GMT
1493
1494### Patches
1495
1496- Update the schema validator.
1497
1498## 2.3.4
1499Thu, 24 Aug 2017 01:04:33 GMT
1500
1501*Version update only*
1502
1503## 2.3.3
1504Tue, 22 Aug 2017 13:04:22 GMT
1505
1506### Patches
1507
1508- Added "api-documenter" code sample
1509
1510## 2.3.2
1511Tue, 15 Aug 2017 01:29:31 GMT
1512
1513### Patches
1514
1515- Introduce Span parser for upcoming *.d.ts generator
1516
1517## 2.3.1
1518Thu, 27 Jul 2017 01:04:48 GMT
1519
1520### Patches
1521
1522- Upgrade to the TS2.4 version of the build tools.
1523
1524## 2.3.0
1525Tue, 25 Jul 2017 20:03:31 GMT
1526
1527### Minor changes
1528
1529- Upgrade to TypeScript 2.4
1530
1531## 2.2.0
1532Wed, 21 Jun 2017 04:19:35 GMT
1533
1534### Minor changes
1535
1536- Add two new features: An error is reported if a top-level definition is missing its release tag. The constructor summary will now be autogenerated if omitted.
1537
1538## 2.0.10
1539Tue, 20 Jun 2017 01:04:54 GMT
1540
1541### Patches
1542
1543- Improve the wording of many error messages
1544- Fix a bug with parsing of @link tags
1545- Issue warnings for @internal definitions that are not prefixed with an underscore
1546
1547## 2.0.9
1548Sat, 17 Jun 2017 01:02:59 GMT
1549
1550### Patches
1551
1552- The unsupported @summary tag is now reported as an error
1553- Use a cache to speed up package.json lookups
1554
1555## 2.0.8
1556Wed, 14 Jun 2017 13:03:40 GMT
1557
1558### Patches
1559
1560- Definitions marked as @beta are now included in the *.api.json files for documentation
1561
1562## 2.0.7
1563Thu, 08 Jun 2017 05:15:52 GMT
1564
1565### Patches
1566
1567- Updated README.md
1568
1569## 2.0.6
1570Mon, 15 May 2017 21:59:43 GMT
1571
1572### Patches
1573
1574- Added support for Namespace with ApiNamespace
1575
1576## 2.0.5
1577Sat, 22 Apr 2017 01:02:03 GMT
1578
1579### Patches
1580
1581- Added check for API names that are not supported (only letters and numbers supported)
1582
1583## 2.0.4
1584Wed, 19 Apr 2017 20:18:06 GMT
1585
1586### Patches
1587
1588- Remove ES6 Promise & @types/es6-promise typings
1589
1590## 2.0.3
1591Fri, 14 Apr 2017 17:44:08 GMT
1592
1593### Patches
1594
1595- Added collect references ability to detect determine type information of return types and parameter types.
1596
1597## 2.0.2
1598Fri, 07 Apr 2017 21:43:16 GMT
1599
1600### Patches
1601
1602- Adjusted the version specifier for typescript to ~2.2.2
1603
1604## 2.0.1
1605Thu, 06 Apr 2017 01:32:23 GMT
1606
1607### Patches
1608
1609- Removed hard coding of @public for ApiPackage
1610
1611## 2.0.0
1612Mon, 20 Mar 2017 21:52:20 GMT
1613
1614### Breaking changes
1615
1616- Fixing whitespace, also a variable that was shadowing another variable.
1617
1618## 1.1.19
1619Mon, 20 Mar 2017 04:20:13 GMT
1620
1621### Patches
1622
1623- Reverting change.
1624
1625## 1.1.18
1626Mon, 20 Mar 2017 03:50:55 GMT
1627
1628### Patches
1629
1630- Reverting previous change, which causes a regression in SPFx yeoman sc enario.
1631
1632## 1.1.17
1633Mon, 20 Mar 2017 00:54:03 GMT
1634
1635### Patches
1636
1637- Fixing lint whitespace issues.
1638
1639## 1.1.16
1640Sun, 19 Mar 2017 19:10:30 GMT
1641
1642### Patches
1643
1644- Fixing variable that was shadowing another variable.
1645
1646## 1.1.15
1647Wed, 15 Mar 2017 01:32:09 GMT
1648
1649### Patches
1650
1651- Locking `@types` packages. Synchronizing version specifiers for dependencies with other `web-build-tools` projects.
1652
1653## 1.1.14
1654Sat, 18 Feb 2017 02:32:06 GMT
1655
1656### Patches
1657
1658- Seperated the ApiItem initialization into 3 stages: create documentation that doesn't require resolution, then complete initialization by resolving links and inheritdocs. This allows us to ignore harmless cycles like type references"
1659
1660## 1.1.13
1661Thu, 16 Feb 2017 22:10:39 GMT
1662
1663### Patches
1664
1665- Fixed Api-Extractor error message, changed apostrophe to backtick.
1666
1667## 1.1.12
1668Thu, 16 Feb 2017 18:56:57 GMT
1669
1670### Patches
1671
1672- Added support for local API definition resolution"
1673
1674## 1.1.11
1675Sat, 11 Feb 2017 02:32:35 GMT
1676
1677### Patches
1678
1679- Changed dependency for ApiDocumentation to abstract the resolving of API definition references.
1680
1681## 1.1.10
1682Fri, 10 Feb 2017 20:01:30 GMT
1683
1684### Patches
1685
1686- Added support to not throw error, instead report error if no type is declared on properties and parameters
1687
1688## 1.1.9
1689Tue, 07 Feb 2017 20:37:06 GMT
1690
1691### Patches
1692
1693- Fixing issue where undocumented comment was not being emitted.
1694
1695## 1.1.8
1696Sat, 04 Feb 2017 02:32:05 GMT
1697
1698### Patches
1699
1700- Moved ApiItem references within ApiDocumentation, to ApiItem caller.
1701
1702## 1.1.7
1703Thu, 02 Feb 2017 14:05:53 GMT
1704
1705### Patches
1706
1707- Refactored ApiDocumentation creation to resolve references method.
1708
1709## 1.1.6
1710Wed, 01 Feb 2017 20:09:30 GMT
1711
1712### Patches
1713
1714- Added ApiItemKind enum and refactored child classes.
1715
1716## 1.1.5
1717Fri, 27 Jan 2017 20:04:15 GMT
1718
1719### Patches
1720
1721- Changed name of Analyzer to Extractor, added support for external api json doc loading.
1722
1723## 1.1.4
1724Fri, 27 Jan 2017 02:35:10 GMT
1725
1726### Patches
1727
1728- Added ExternalApiHelper class to be used in generating api documentation json files for external types.
1729- Added description for packages implementation.
1730- Added config folder with file to enable api-extractor on itself. rebuild project on previous build.
1731
1732## 1.1.3
1733Tue, 24 Jan 2017 01:36:35 GMT
1734
1735### Patches
1736
1737- Json schema was updated to reflect feature additions to linkDocElement. The linkDocElement can now be of type 'code' which refers to an API definition reference.
1738
1739## 1.1.2
1740Fri, 20 Jan 2017 01:46:41 GMT
1741
1742*Version update only*
1743
1744## 1.1.1
1745Thu, 19 Jan 2017 20:04:40 GMT
1746
1747### Patches
1748
1749- Check for missing JSDoc sequences changed.
1750- Improved error messages
1751
1752## 1.1.0
1753Wed, 18 Jan 2017 20:04:29 GMT
1754
1755### Minor changes
1756
1757- Updating API Extractor to work with TypeScript 2.1
1758
1759## 1.0.2
1760Mon, 16 Jan 2017 20:04:15 GMT
1761
1762### Patches
1763
1764- @link capability for href and API definition references
1765
1766## 1.0.1
1767Fri, 13 Jan 2017 06:46:05 GMT
1768
1769*Version update only*
1770
1771## 1.0.0
1772Wed, 11 Jan 2017 14:11:26 GMT
1773
1774### Breaking changes
1775
1776- Introducing API Extractor
1777