API Extractor
Search documentation
Docs
News
API
GitHub
Help
Get Started
Navigation Menu
Overview
What is API Extractor?
A sample project
The API report
The .d.ts rollup
API documentation
Setting up your project
Invoking API Extractor
Configuring an API report
Configuring a .d.ts rollup
Generating API docs
Integrating a custom doc pipeline
Getting help
Doc comment syntax
Overview
Declaration references
@alpha
@beta
@defaultValue
@deprecated
@eventProperty
@example
{@inheritDoc}
@internal
{@link}
@override
@packageDocumentation
@param
@preapproved
@privateRemarks
@public
@readonly
@remarks
@returns
@sealed
@typeParam
@virtual
Message reference
ae-cyclic-inherit-doc
ae-different-release-tags
ae-extra-release-tag
ae-forgotten-export
ae-incompatible-release-tags
ae-internal-missing-underscore
ae-internal-mixed-release-tag
ae-misplaced-package-tag
ae-missing-getter
ae-missing-release-tag
ae-preapproved-bad-release-tag
ae-preapproved-unsupported-type
ae-setter-with-docs
ae-unresolved-inheritdoc-base
ae-unresolved-inheritdoc-reference
ae-unresolved-link
ae-wrong-input-file-type
Command line
api-extractor init
api-extractor run
api-documenter markdown
api-documenter yaml
Config files
api-extractor.json
tsdoc.json
Developer scenarios
API packages
Contributing
Building the code
Debugging
Architecture notes