Home

API Reference

Packages

Package Description
@microsoft/api-documenter API Documenter generates an API reference website from the .api.json files created by API Extractor. The @microsoft/api-documenter package provides the command-line tool. It also exposes a developer API that you can use to create plugins that customize how API Documenter generates documentation.
@microsoft/api-extractor API Extractor helps with validation, documentation, and reviewing of the exported API for a TypeScript library. The @microsoft/api-extractor package provides the command-line tool. It also exposes a developer API that you can use to invoke API Extractor programmatically.
@microsoft/api-extractor-model Use this library to read and write *.api.json files as defined by the API Extractor tool. These files are used to generate a documentation website for your TypeScript package. The files store the API signatures and doc comments that were extracted from your package.
@microsoft/node-core-library Core libraries that every NodeJS toolchain project should use.
@microsoft/package-deps-hash This package builds a JSON object containing the git hashes of all files used to produce a given NPM package. The Rush tool uses this library to implement incremental build detection.
@microsoft/rush-lib A library for writing scripts that interact with the Rush tool.
@microsoft/stream-collator This library enables a tool to display live console output from multiple asynchronous processes, while ensuring that their output does not get jumbled together.
@microsoft/ts-command-line An object-oriented command-line parser for TypeScript projects.