Analyze the exported API for a TypeScript library and generate reviews, documentation, and .d.ts rollups
Last release 6 days ago
21 Aug 2026
Ships fairly regularly
a new release about every 3 weeks
Nearly every release is documented
notes for 60 of the last 60 stable releases
1 version withdrawn
withdrawn after publishing
10 years old
552 releases · first in 2017
Release timeline
552 releases since 201720172019202120232025
Releases
- 7.0.3121 Mar 2019
Release notes
Open source →Mon, 11 Mar 2019 16:13:36 GMT
Patches
- Update api-documenter to use the new NPM package @microsoft/api-extractor-model; eliminate dependencies on @microsoft/api-extractor or the TypeScript compiler
Additional notes
Open source →Thu, 21 Mar 2019 04:59:11 GMT
Patches
- Reintroduce "ae-internal-missing-underscore" warning for API items marked as
@internalbut whose name does not start with an underscore
- 7.0.3021 Mar 2019
Additional notes
Open source →Thu, 21 Mar 2019 01:15:32 GMT
Patches
- Improve the API review file generation to include imports and support multiple exports
- 7.0.2920 Mar 2019
Additional notes
Open source →Wed, 20 Mar 2019 19:14:49 GMT
Patches
- API Extractor can now analyze packages whose package.json file is missing the "version" field
- 7.0.2818 Mar 2019
Additional notes
Open source →Mon, 18 Mar 2019 04:28:43 GMT
Patches
- Rename the "ae-inconsistent-release-tags" warning to "ae-different-release-tags"
- Introduce a new warning "ae-incompatible-release-tags" that checks for API signatures that reference types with incompatible release tags
- Fix an issue where this error was sometimes reported incorrectly: "The messages.extractorMessageReporting table contains an unrecognized identifier ___"
- 7.0.2716 Mar 2019
Additional notes
Open source →Fri, 15 Mar 2019 19:13:25 GMT
Patches
- (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
- 7.0.2613 Mar 2019
Additional notes
Open source →Wed, 13 Mar 2019 19:13:14 GMT
Patches
- Refactor code to move the IndentedWriter API from api-extractor-model to api-documenter
- 7.0.2513 Mar 2019
- 7.0.2411 Mar 2019
Additional notes
Open source →Mon, 11 Mar 2019 16:13:36 GMT
Patches
- Fix an issue where spurious TSDoc warnings were issued because the TSDoc parser was configured improperly
- Move the .api.json related APIs into a new NPM package @microsoft/api-extractor-model
- 7.0.235 Mar 2019
Additional notes
Open source →Tue, 05 Mar 2019 17:13:11 GMT
Patches
- Issue a warning when an exported type refers to another local type that is not exported (ae-forgotten-export)
- The export analyzer now correctly handles symbols imported using "import x = require('y');" notation
- 7.0.224 Mar 2019
Additional notes
Open source →Mon, 04 Mar 2019 17:13:19 GMT
Patches
- Every error/warning message reported by API Extractor now has an associated message identifier
- Add a new section to api-extractor.json for configuring how errors get reported, with ability to suppress individual errors
- Reintroduce the ability to report issues by writing warnings into the API review file
- Fix an issue where members of type literals were incorrectly being flagged as "(undocumented)"
- Error messages now cite the original .ts source file, if a source map is present. (To enable this, specify
"declarationMap": truein tsconfig.json.)
- 7.0.2127 Feb 2019
Release notes
Open source →Thu, 31 Jan 2019 17:03:49 GMT
Patches
- Fix issue where docs were not generated for function parameters and return types (GitHub #1055)
- Upgrade to TSDoc 0.12.5
- 7.0.2027 Feb 2019
- 7.0.1924 Feb 2019
Additional notes
Open source →Mon, 18 Feb 2019 17:13:23 GMT
Minor changes
- New way to resolve & generate TSDoc metadata file
- 7.0.1812 Feb 2019
Release notes
Open source →Sat, 19 Jan 2019 01:17:51 GMT
Patches
- [api-documenter] Enable Office snippets to match multiple versions
Additional notes
Open source →Tue, 12 Feb 2019 17:13:12 GMT
Patches
- 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)
- 7.0.1711 Feb 2019
Release notes
Open source →Fri, 18 Jan 2019 22:04:59 GMT
Patches
- MarkdownEmitter: break for inline tags
Additional notes
Open source →Mon, 11 Feb 2019 10:32:37 GMT
Patches
- Fix an issue where API Extractor neglected to analyze "typeof" expressions
- Fix an issue where declarations inside a namespace were sometimes being incorrectly emitted as top-level exports of the .d.ts rollup
- 7.0.1611 Feb 2019
Additional notes
Open source →Mon, 11 Feb 2019 08:55:57 GMT
Patches
- 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
- Fix a number of bugs where external symbols were misinterpreted as being part of the local project
- Eliminate a number of errors involving unusual language constructs, by avoiding analysis of external symbols unless it's really necessary
- Simplify the AstSymbol.nominalAnalysis concept and associated code
- Improve .d.ts rollup trimming to handle reexported symbols correctly
- 7.0.1511 Feb 2019
Additional notes
Open source →Mon, 11 Feb 2019 03:31:55 GMT
Patches
- The
--debugparameter now automatically breaks in the debugger when InternalError is thrown
- The
- 7.0.1431 Jan 2019
Additional notes
Open source →Thu, 31 Jan 2019 17:03:49 GMT
Patches
- Upgrade to TSDoc 0.12.5, which allows
$in@paramnames - Add "testMode" option in api-extractor.json to eliminate spurious diffs in test files when the version number gets bumped
- Normalize newlines for excerpt strings in the .api.json file
- Upgrade to TSDoc 0.12.5, which allows
- 7.0.1319 Jan 2019
Release notes
Open source →Thu, 10 Jan 2019 01:57:52 GMT
Patches
- Work around an issue where GitHub Pages cannot render
<p></p>inside a pipes-and-dashes table (even though GHFM supports this)
Additional notes
Open source →Sat, 19 Jan 2019 03:47:47 GMT
Patches
- Move the skipLibCheck into the config file.
- Work around an issue where GitHub Pages cannot render
- 7.0.1219 Jan 2019
Release notes
Open source →Wed, 09 Jan 2019 22:04:17 GMT
Patches
- Support more API types for the markdown generator: namespace, function, type alias, variable
Additional notes
Open source →Sat, 19 Jan 2019 01:17:51 GMT
Patches
- Fix an issue where files using "export=" were incorrectly interpreted as having ambient declarations
- 7.0.1118 Jan 2019
Additional notes
Open source →Fri, 18 Jan 2019 00:52:21 GMT
Patches
- Add support for circular references between files that use
export * from "____";
- Add support for circular references between files that use
- 7.0.1017 Jan 2019
Additional notes
Open source →Thu, 17 Jan 2019 00:37:54 GMT
Patches
- Add support for exports of the form
export * from "____"; - Improve the analyzer to allow a declaration to be exported more than once
- Fix inconsistent newlines in .api.ts files
- Add support for exports of the form
- 7.0.910 Jan 2019
Release notes
Open source →Wed, 19 Dec 2018 05:57:33 GMT
Patches
- Update to work with refactored ApiModel classes
Additional notes
Open source →Thu, 10 Jan 2019 01:57:52 GMT
Patches
- Fix an issue with rolling up default exports (https://github.com/microsoft/web-build-tools/issues/1007)
- 7.0.820 Dec 2018
Additional notes
Open source →Thu, 20 Dec 2018 17:04:08 GMT
Patches
- 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
- 7.0.719 Dec 2018
Additional notes
Open source →Wed, 19 Dec 2018 05:57:33 GMT
Patches
- Extend ApiModel to support new item kinds: ApiCallSignature, ApiConstructor, ApiConstructSignature, ApiFunction, ApiIndexSignature, ApiTypeAlias, and ApiVariable
- 7.0.614 Dec 2018
Release notes
Open source →Wed, 12 Dec 2018 17:04:19 GMT
Patches
- The YAML exporter now documents "extends" and "implements" heritage
- 7.0.513 Dec 2018
- 7.0.412 Dec 2018
Release notes
Open source →Fri, 07 Dec 2018 17:04:56 GMT
Patches
- Updated to use the new InternalError class for reporting software defects
Additional notes
Open source →Wed, 12 Dec 2018 17:04:19 GMT
Patches
- Reintroduce support for "extends" and "implements" heritage clauses
- Redesign the Excerpt API to support multiple subranges (e.g. for a list of "implements" clauses)
- 7.0.37 Dec 2018
- 7.0.25 Dec 2018
Additional notes
Open source →Wed, 05 Dec 2018 19:57:03 GMT
Patches
- fix reexported types from an external package for dts rollup
- 7.0.15 Dec 2018
Additional notes
Open source →Wed, 05 Dec 2018 17:04:18 GMT
Patches
- Fix an issue where .d.ts trimming did not properly handle variable declarations (GitHub #976)
- 7.0.029 Nov 2018
Release notes2 sources agree
Open source →Thu, 29 Nov 2018 07:02:09 GMT
Breaking changes
- 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.
- 6.3.028 Nov 2018
Release notes
Open source →Wed, 28 Nov 2018 19:29:53 GMT
Minor changes
- Support "extends" field in api-extractor.json config files for easier management of monorepos with many projects
- 6.2.028 Nov 2018
Release notes
Open source →Wed, 28 Nov 2018 02:17:11 GMT
Minor changes
- Introduce a new build output "dist/tsdoc-metdata.json", which completely replaces the old "tsdocFlavor" field in package.json
- 6.1.616 Nov 2018
Release notes
Open source →Fri, 16 Nov 2018 21:37:10 GMT
Patches
- Add support for emitting
/// <reference lib="___" />directives in .d.ts rollups (GitHub issue #946)
- Add support for emitting
- 6.1.516 Nov 2018
Release notes
Open source →Fri, 16 Nov 2018 00:59:00 GMT
Patches
- Fix an issue where .d.ts trimming did not work for exported variable declarations (GitHub #936)
- 6.1.49 Nov 2018
Release notes
Open source →Fri, 09 Nov 2018 23:07:39 GMT
Patches
- Upgrade to TSDoc 0.21.2, which improves trimming of link text in
@linktags
- Upgrade to TSDoc 0.21.2, which improves trimming of link text in
- 6.1.37 Nov 2018
- 6.1.25 Nov 2018
- 6.1.11 Nov 2018
Release notes
Open source →Thu, 01 Nov 2018 19:32:52 GMT
Patches
- Fix an issue where EcmaScript symbols ("computed property names") were missing from .d.ts rollups
- 6.1.031 Oct 2018
Release notes
Open source →Wed, 31 Oct 2018 17:00:54 GMT
Minor changes
- Added an api to invoke api extractor processor by supplying api extractor json config file.
- 6.0.925 Oct 2018
- 6.0.825 Oct 2018
Release notes
Open source →Thu, 25 Oct 2018 08:56:02 GMT
Patches
- Fix issue where
DocErrorText.textreturned[object Object]instead of the text
- Fix issue where
- 6.0.724 Oct 2018
- 6.0.618 Oct 2018
Release notes
Open source →Thu, 18 Oct 2018 01:32:20 GMT
Patches
- Fix isAbsolute check for mainDtsRollupPath
- 6.0.517 Oct 2018
- 6.0.417 Oct 2018
Release notes
Open source →Wed, 17 Oct 2018 14:43:24 GMT
Patches
- Fix a regression where namespaces were sometimes incorrectly handled in "conservative" mode
- Update the command line to look for api-extractor.json in both the "./config" folder and the project folder
- Allow type references in namespaces when namespaceSupport=conservative
- 6.0.311 Oct 2018
Release notes
Open source →Thu, 11 Oct 2018 23:26:07 GMT
Patches
- Fix an issue where
import x from "."was sometimes not processed correctly
- Fix an issue where
- 6.0.29 Oct 2018
Release notes
Open source →Tue, 09 Oct 2018 06:58:01 GMT
Patches
- Fix a regression where API Extractor was sometimes reporting incorrect line numbers
- 6.0.18 Oct 2018
- 6.0.07 Oct 2018
Release notes
Open source →Sun, 07 Oct 2018 06:15:56 GMT
Breaking changes
- (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
- 5.13.128 Sept 2018
- 5.13.026 Sept 2018
Release notes
Open source →Wed, 26 Sep 2018 21:39:40 GMT
Minor changes
- Add new command line option --skip-lib-check
- 5.12.224 Sept 2018
Release notes
Open source →Mon, 24 Sep 2018 23:06:40 GMT
Patches
- Allow doc comments to use TSDoc's "@defaultvalue" tag (but the value is not yet passed to the documentation pipeline)
- 5.12.121 Sept 2018
Release notes
Open source →Fri, 21 Sep 2018 16:04:42 GMT
Patches
- Fix an issue where TypeScript errors are often logged as "[Object object]" instead of the actual error message.
- 5.12.020 Sept 2018
Release notes
Open source →Thu, 20 Sep 2018 23:57:21 GMT
Minor changes
- Add new feature: Support using a different version of the TypeScript compiler.
- 5.11.218 Sept 2018
Release notes
Open source →Tue, 18 Sep 2018 21:04:55 GMT
Patches
- Fix an issue where parameters mentioned in comments were attempting to be analyzed by api-extractor.
- 5.11.16 Sept 2018
Release notes
Open source →Thu, 06 Sep 2018 01:25:25 GMT
Patches
- Update "repository" field in package.json
- 5.11.03 Sept 2018
Release notes
Open source →Mon, 03 Sep 2018 16:04:45 GMT
Minor changes
- Upgrade api-extractor to internally use TypeScript 3.0.
- 5.10.829 Aug 2018