npm · #4181

@microsoft/api-extractor

7.59.0microsoft/rushstack ↗

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 2017

20172019202120232025

Releases

4.3.028 Nov 2017
Release notes
Tue, 28 Nov 2017 23:43:55 GMT

Minor changes
- Add Extractor.processProject() whose return value indicates success
Patches
- Deprecate Extractor.analyzeProject() API
Open source →
4.2.613 Nov 2017
Release notes
Mon, 13 Nov 2017 17:04:50 GMT

Version update only

Open source →
4.2.56 Nov 2017
Release notes
Mon, 06 Nov 2017 17:04:18 GMT

Version update only

Open source →
4.2.42 Nov 2017
Release notes
Thu, 02 Nov 2017 16:05:24 GMT

Patches
- lock the reference version between web build tools projects
Open source →
4.2.31 Nov 2017
Release notes
Wed, 01 Nov 2017 21:06:08 GMT

Patches
- Upgrade cyclic dependencies
Open source →
4.2.231 Oct 2017
Release notes
Tue, 31 Oct 2017 21:04:04 GMT

Version update only

Open source →
4.2.131 Oct 2017
Release notes
Tue, 31 Oct 2017 16:04:55 GMT

Version update only

Open source →
4.2.025 Oct 2017
Release notes
Wed, 25 Oct 2017 20:03:59 GMT

Minor changes
- Improved the way API JSON represents documentation markup; this is a file format change
Open source →
4.1.224 Oct 2017
Release notes
Tue, 24 Oct 2017 18:17:12 GMT

Version update only

Open source →
4.1.123 Oct 2017
Release notes
Mon, 23 Oct 2017 21:53:12 GMT

Patches
- Updated cyclic dependencies
Open source →
4.1.020 Oct 2017
Release notes
Fri, 20 Oct 2017 19:57:12 GMT

Minor changes
- Add policies.namespaceSupport option to API Extractor config
Patches
- Fixed an issue where properties were sometimes marked as readonly; a remark is automatically generated for classes with internal constructors
Open source →
4.0.120 Oct 2017
Release notes
Fri, 20 Oct 2017 01:52:54 GMT

Patches
- Rename ApiExtractor class to Extractor
Open source →
4.0.020 Oct 2017
Release notes
Fri, 20 Oct 2017 01:04:44 GMT

Breaking changes
- Redesigned interface for invoking API Extractor
Open source →
3.4.25 Oct 2017
Release notes
Thu, 05 Oct 2017 01:05:02 GMT

Version update only

Open source →
3.4.129 Sept 2017
Release notes
Fri, 29 Sep 2017 01:03:42 GMT

Patches
- Removed IMarkupPage.docId
Open source →
3.4.028 Sept 2017
Release notes
Thu, 28 Sep 2017 01:04:28 GMT

Minor changes
- Skipping two lines in an AEDoc comment now creates a paragraph separator for the generated documentation
Patches
- The *.api.json "linkDocElement" type now always explicitly specifies the package name, rather than expecting the reader to infer it
- The *.api.json file format now exposes "signature" information for properties, functions, and module variables
Open source →
3.3.022 Sept 2017
Release notes
Fri, 22 Sep 2017 01:04:02 GMT

Minor changes
- Upgrade to es6
Open source →
3.2.620 Sept 2017
Release notes
Wed, 20 Sep 2017 22:10:17 GMT

Version update only

Open source →
3.2.511 Sept 2017
Release notes
Mon, 11 Sep 2017 13:04:55 GMT

Patches
- The isBeta and deprecatedMessage fields are now inherited in the *.api.json files
- Fix an issue where the *.api.json file was sometimes missing function parameters
Open source →
3.2.48 Sept 2017
Release notes
Fri, 08 Sep 2017 01:28:04 GMT

Patches
- Deprecate @types/es6-coll ections in favor of built-in typescript typings 'es2015.collection' a nd 'es2015.iterable'
Open source →
3.2.37 Sept 2017
Release notes
Thu, 07 Sep 2017 13:04:35 GMT

Patches
- Fix incorrect schema/typings for enum members
Open source →
3.2.27 Sept 2017
Release notes
Thu, 07 Sep 2017 00:11:11 GMT

Patches
- Add $schema field to all schemas
Open source →
3.2.16 Sept 2017
Release notes
Wed, 06 Sep 2017 13:03:42 GMT

Patches
- Converted IMarkupDocumentationLink to IMarkupApiLink, which exposes the underlying IApiItemReference rather than assuming a particular "document ID" model
Open source →
3.2.05 Sept 2017
Release notes
Tue, 05 Sep 2017 19:03:56 GMT

Minor changes
- Add the constructor signature and package name to the exported API signature
Open source →
3.1.02 Sept 2017
Release notes
Sat, 02 Sep 2017 01:04:26 GMT

Minor changes
- Expanded the api-extractor API to expose interfaces for the *.api.json file fileformat
Open source →
3.0.031 Aug 2017
Release notes
Thu, 31 Aug 2017 18:41:18 GMT

Breaking changes
- Fix compatibility issues with old releases, by incrementing the major version number
Open source →
2.3.831 Aug 2017
Nothing published for this version
2.3.731 Aug 2017
Release notes
Thu, 31 Aug 2017 17:46:25 GMT

Patches
- Fix issue where node-core-library was not an explicit dependency
Open source →
2.3.630 Aug 2017
Release notes
Wed, 30 Aug 2017 01:04:34 GMT

Version update only

Open source →
2.3.524 Aug 2017
Release notes
Thu, 24 Aug 2017 22:44:12 GMT

Patches
- Update the schema validator.
Open source →
2.3.424 Aug 2017
Release notes
Thu, 24 Aug 2017 01:04:33 GMT

Version update only

Open source →
2.3.322 Aug 2017
Release notes
Tue, 22 Aug 2017 13:04:22 GMT

Patches
- Added "api-documenter" code sample
Open source →
2.3.215 Aug 2017
Release notes
Tue, 15 Aug 2017 01:29:31 GMT

Patches
- Introduce Span parser for upcoming *.d.ts generator
Open source →
2.3.127 Jul 2017
Release notes
Thu, 27 Jul 2017 01:04:48 GMT

Patches
- Upgrade to the TS2.4 version of the build tools.
Open source →
2.3.025 Jul 2017
Release notes
Tue, 25 Jul 2017 20:03:31 GMT

Minor changes
- Upgrade to TypeScript 2.4
Open source →
2.2.021 Jun 2017
Release notes
Wed, 21 Jun 2017 04:19:35 GMT

Minor changes
- 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.
Open source →
2.1.020 Jun 2017
Nothing published for this version
2.0.1020 Jun 2017
Release notes
Tue, 20 Jun 2017 01:04:54 GMT

Patches
- Improve the wording of many error messages
- Fix a bug with parsing of @link tags
- Issue warnings for @internal definitions that are not prefixed with an underscore
Open source →
2.0.917 Jun 2017
Release notes
Sat, 17 Jun 2017 01:02:59 GMT

Patches
- The unsupported @summary tag is now reported as an error
- Use a cache to speed up package.json lookups
Open source →
2.0.814 Jun 2017
Release notes
Wed, 14 Jun 2017 13:03:40 GMT

Patches
- Definitions marked as @beta are now included in the *.api.json files for documentation
Open source →
2.0.78 Jun 2017
Release notes
Thu, 08 Jun 2017 05:15:52 GMT

Patches
- Updated README.md
Open source →
2.0.64 May 2017
Release notes
Mon, 15 May 2017 21:59:43 GMT

Patches
- Added support for Namespace with ApiNamespace
Open source →
2.0.522 Apr 2017
Release notes
Sat, 22 Apr 2017 01:02:03 GMT

Patches
- Added check for API names that are not supported (only letters and numbers supported)
Open source →
2.0.419 Apr 2017
Release notes
Wed, 19 Apr 2017 20:18:06 GMT

Patches
- Remove ES6 Promise & @types/es6-promise typings
Open source →
2.0.314 Apr 2017
Release notes
Fri, 14 Apr 2017 17:44:08 GMT

Patches
- Added collect references ability to detect determine type information of return types and parameter types.
Open source →
2.0.27 Apr 2017
Release notes
Fri, 07 Apr 2017 21:43:16 GMT

Patches
- Adjusted the version specifier for typescript to ~2.2.2
Open source →
2.0.16 Apr 2017
Release notes
Thu, 06 Apr 2017 01:32:23 GMT

Patches
- Removed hard coding of @public for ApiPackage
Open source →
2.0.020 Mar 2017
Release notes
Mon, 20 Mar 2017 21:52:20 GMT

Breaking changes
- Fixing whitespace, also a variable that was shadowing another variable.
Open source →
1.1.1920 Mar 2017
Release notes
Mon, 12 Mar 2018 20:36:19 GMT

Patches
- Locked down some "@types/" dependency versions to avoid upgrade conflicts
Open source →
Additional notes
Mon, 20 Mar 2017 04:20:13 GMT

Patches
- Reverting change.
Open source →
1.1.1820 Mar 2017
Release notes
Tue, 06 Mar 2018 17:04:51 GMT

Version update only

Open source →
Additional notes
Mon, 20 Mar 2017 03:50:55 GMT

Patches
- Reverting previous change, which causes a regression in SPFx yeoman sc enario.
Open source →
1.1.1720 Mar 2017
Release notes
Fri, 02 Mar 2018 01:13:59 GMT

Version update only

Open source →
Additional notes
Mon, 20 Mar 2017 00:54:03 GMT

Patches
- Fixing lint whitespace issues.
Open source →
1.1.1619 Mar 2017
Release notes
Tue, 27 Feb 2018 22:05:57 GMT

Version update only

Open source →
Additional notes
Sun, 19 Mar 2017 19:10:30 GMT

Patches
- Fixing variable that was shadowing another variable.
Open source →
1.1.1515 Mar 2017
Release notes
Wed, 21 Feb 2018 22:04:19 GMT

Version update only

Open source →
Additional notes
Wed, 15 Mar 2017 01:32:09 GMT

Patches
- Locking @types packages. Synchronizing version specifiers for dependencies with other web-build-tools projects.
Open source →
1.1.1418 Feb 2017
Release notes
Wed, 21 Feb 2018 03:13:29 GMT

Version update only

Open source →
Additional notes
Sat, 18 Feb 2017 02:32:06 GMT

Patches
- 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"
Open source →
1.1.1316 Feb 2017
Release notes
Sat, 17 Feb 2018 02:53:49 GMT

Version update only

Open source →
Additional notes
Thu, 16 Feb 2017 22:10:39 GMT

Patches
- Fixed Api-Extractor error message, changed apostrophe to backtick.
Open source →
1.1.1216 Feb 2017
Release notes
Fri, 16 Feb 2018 22:05:23 GMT

Version update only

Open source →
Additional notes
Thu, 16 Feb 2017 18:56:57 GMT

Patches
- Added support for local API definition resolution"
Open source →
1.1.1111 Feb 2017
Release notes
Fri, 16 Feb 2018 17:05:11 GMT

Version update only

Open source →
Additional notes
Sat, 11 Feb 2017 02:32:35 GMT

Patches
- Changed dependency for ApiDocumentation to abstract the resolving of API definition references.
Open source →
1.1.1010 Feb 2017
Release notes
Wed, 07 Feb 2018 17:05:11 GMT

Version update only

Open source →
Additional notes
Fri, 10 Feb 2017 20:01:30 GMT

Patches
- Added support to not throw error, instead report error if no type is declared on properties and parameters
Open source →
1.1.97 Feb 2017
Release notes
Fri, 26 Jan 2018 22:05:30 GMT

Version update only

Open source →
Additional notes
Tue, 07 Feb 2017 20:37:06 GMT

Patches
- Fixing issue where undocumented comment was not being emitted.
Open source →
1.1.84 Feb 2017
Release notes
Fri, 26 Jan 2018 17:53:38 GMT

Patches
- Force a patch bump in case the previous version was an empty package
Open source →
Additional notes
Sat, 04 Feb 2017 02:32:05 GMT

Patches
- Moved ApiItem references within ApiDocumentation, to ApiItem caller.
Open source →

@microsoft/api-extractor

Release timeline

Releases

Minor changes

Patches

Patches

Patches

Minor changes

Patches

Minor changes

Patches

Patches

Breaking changes

Patches

Minor changes

Patches

Minor changes

Patches

Patches

Patches

Patches

Patches

Minor changes

Minor changes

Breaking changes

Patches

Patches

Patches

Patches

Patches

Minor changes

Minor changes

Patches

Patches

Patches

Patches

Patches

Patches

Patches

Patches

Patches

Patches

Breaking changes

Patches

Patches

Patches

Patches

Patches

Patches

Patches

Patches

Patches

Patches

Patches

Patches

Patches

Patches