A helper library for loading and saving the .api.json files created by API Extractor
Last release 8 days ago
20 Aug 2026
Release timing varies
gaps range from 8 days to 3 months
Nearly every release is documented
notes for 60 of the last 60 stable releases
Nothing withdrawn
no release was ever pulled
8 years old
224 releases · first in 2018
Release timeline
224 releases since 2018Releases
- 7.8.426 May 2020
- 7.8.322 May 2020
- 7.8.221 May 2020
- 7.8.121 May 2020
- 7.8.06 May 2020
Release notes
Open source →Wed, 06 May 2020 08:23:45 GMT
Minor changes
- For markdown output, parameter types and return types are now hyperlinked to the corresponding API item
Additional notes
Open source →Wed, 06 May 2020 08:23:45 GMT
Minor changes
- Enable canonicalReference to ApiItem lookup
- 7.7.118 Apr 2020
- 7.7.1028 Mar 2020
- 7.7.918 Mar 2020
- 7.7.817 Mar 2020
Additional notes
Open source →Tue, 17 Mar 2020 23:55:58 GMT
Patches
- Replace dependencies whose NPM scope was renamed from
@microsoftto@rushstack
- Replace dependencies whose NPM scope was renamed from
- 7.7.728 Jan 2020
- 7.7.623 Jan 2020
- 7.7.521 Jan 2020
- 7.7.419 Jan 2020
- 7.7.317 Jan 2020
- 7.7.29 Jan 2020
- 7.7.18 Jan 2020
- 7.7.03 Dec 2019
Release notes
Open source →Sun, 24 Nov 2019 00:54:04 GMT
Minor changes
- Add a new command-line option --new-docfx-namespaces to improve how namespaces are represented when generating YAML for DocFX
- Added support for
@throws
Additional notes
Open source →Tue, 03 Dec 2019 03:17:43 GMT
Minor changes
- Improve declaration reference syntax to allow linking to overloaded functions/methods
- 7.6.024 Nov 2019
Release notes
Open source →Fri, 15 Nov 2019 04:50:50 GMT
Minor changes
- Make newline type for generated files configurable
- 7.5.615 Nov 2019
- 7.5.511 Nov 2019
- 7.5.45 Nov 2019
Additional notes
Open source →Tue, 05 Nov 2019 06:49:28 GMT
Patches
- Fix an issue where API reports sometimes were ordered differently depending on the version of NodeJS (GitHub #1552)
- 7.5.35 Nov 2019
- 7.5.222 Oct 2019
Additional notes
Open source →Tue, 22 Oct 2019 06:24:44 GMT
Patches
- Refactor some code as part of migration from TSLint to ESLint
- 7.5.129 Sept 2019
- 7.5.025 Sept 2019
Release notes
Open source →Sun, 06 Oct 2019 00:27:39 GMT
Minor changes
- For the markdown target, reorder the "Remarks" section to appear before the members for classes, interfaces, namespaces, and packages (GitHub #1550)
Additional notes
Open source →Wed, 25 Sep 2019 15:15:31 GMT
Minor changes
- Add ApiItem.getMergedSiblings() API
- 7.4.223 Sept 2019
Additional notes
Open source →Mon, 23 Sep 2019 15:14:55 GMT
Patches
- Remove unnecessary dependency on @types/node
- 7.4.110 Sept 2019
Release notes
Open source →Tue, 10 Sep 2019 20:38:33 GMT
Patches
- Add support for emitting deeply linked types in YamlDocumenter
- 7.4.010 Sept 2019
Release notes
Open source →Fri, 06 Sep 2019 15:14:57 GMT
Minor changes
- For the markdown target, generate an "index.md" file with an inventory of documented packages
Patches
- (Experimental) Expand the API for API Documenter plugins
Additional notes
Open source →Tue, 10 Sep 2019 20:38:33 GMT
Minor changes
- Add 'canonicalReference' to ExcerptToken
- 7.3.44 Sept 2019
Release notes
Open source →Sat, 29 Jun 2019 02:30:10 GMT
Patches
- Avoid reporting a fatal error when an unknown block tag is encountered
- 7.3.34 Sept 2019
Additional notes
Open source →Wed, 04 Sep 2019 15:15:37 GMT
Patches
- Update TSDoc dependency to 0.12.14
- 7.3.28 Aug 2019
Release notes
Open source →Tue, 11 Jun 2019 00:48:06 GMT
Patches
- Add support for emitting type parameters in the YamlDocumenter
- 7.3.18 Aug 2019
Additional notes
Open source →Thu, 08 Aug 2019 00:49:05 GMT
Patches
- (Experimental) Add ApiExtractor.canonicalReference which is a beta implementation of the revised TSDoc declaration reference notation
- 7.3.022 Jul 2019
Release notes
Open source →Wed, 05 Jun 2019 19:12:34 GMT
Minor changes
- Improved the experimental api-documenter generate command.
Patches
- Fix an issue where TSDoc index selectors (ApiParameterListMixin.overloadIndex) started from 0, whereas TSDoc requires a nonzero number
Additional notes
Open source →Mon, 22 Jul 2019 19:13:10 GMT
Minor changes
- Rename
ApiItem.canonicalReferenceto.containerKey; renameApiItemContainerMixin.tryGetMember()to.tryGetMemberByKey(); renameApi___.getCanonicalReference()to.getContainerKey()
- 7.2.011 Jun 2019
Release notes
Open source →Thu, 16 May 2019 22:15:20 GMT
Minor changes
- Add optional config file
api-documenter.jsonto allow building custom Table of Contents for YamlDocumenter.
Additional notes
Open source →Tue, 11 Jun 2019 00:48:06 GMT
Minor changes
- Add API support for type parameters and type alias types
Patches
- Improve the .api.json deserializer to validate the schema version and support backwards compatibility
- Add optional config file
- 7.1.35 Jun 2019
Additional notes
Open source →Wed, 05 Jun 2019 19:12:34 GMT
Patches
- Fix an issue where TSDoc index selectors (ApiParameterListMixin.overloadIndex) started from 0, whereas TSDoc requires a nonzero number
- 7.1.24 Jun 2019
Release notes
Open source →Mon, 29 Apr 2019 19:13:03 GMT
Patches
- Fix the "Home" link in the breadcrumb when viewing docs using GitHub's markdown renderer
Additional notes
Open source →Tue, 04 Jun 2019 05:51:53 GMT
Patches
- Fix an issue where ApiConstructor inherited from ApiStaticMixin, but TypeScript constructors cannot be static
- 7.1.127 May 2019
Release notes
Open source →Wed, 17 Apr 2019 19:12:31 GMT
Patches
- Fix newline rendering when code blocks are used in tables
Additional notes
Open source →Mon, 27 May 2019 04:13:44 GMT
Patches
- Make the strings returned by ApiItem.displayName less verbose
- Improve formatting of the strings returned by ApiItem.getScopedNameWithinPackage()
- 7.1.016 Apr 2019
Release notes
Open source →Tue, 16 Apr 2019 11:01:37 GMT
Minor changes
- Initial stable release of API Extractor 7
Patches
- Adding an extra newline to the OfficeYamlDocumenter Examples header insertion
Additional notes
Open source →Tue, 16 Apr 2019 11:01:37 GMT
Minor changes
- Initial stable release of API Extractor 7
- 7.0.2820 Mar 2019
- 7.0.2718 Mar 2019
Additional notes
Open source →Mon, 18 Mar 2019 04:28:43 GMT
Patches
- Add helper functions for ReleaseTag
- Export IApiItemConstructor to eliminate the ae-forgotten-export warning
- 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
- Initial setup of new package @microsoft/api-extractor-model
- 0.0.012 Dec 2018
Nothing published for this version