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/rush-lib | A library for writing scripts that interact with the Rush tool. |
| @rushstack/debug-certificate-manager | This package is used to manage debug certificates for development servers. It is used by [@microsoft/gulp-core-build-serve](https://www.npmjs.com/package/@microsoft/gulp-core-build-serve) to generate and trust a certificate when HTTPS is turned on. This package provides the following utilities: - |
| @rushstack/hashed-folder-copy-plugin | |
| @rushstack/heft | |
| @rushstack/heft-config-file | |
| @rushstack/localization-utilities | |
| @rushstack/module-minifier | |
| @rushstack/node-core-library | Core libraries that every NodeJS toolchain project should use. |
| @rushstack/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. |
| @rushstack/rig-package | A system for sharing tool configurations between projects without duplicating config files. |
| @rushstack/rush-serve-plugin | |
| @rushstack/stream-collator | This library enables a tool to display live console output from multiple concurrent processes, while ensuring that their output does not get jumbled together. |
| @rushstack/terminal | This library implements a system for processing human readable text that will be output by console applications. |
| @rushstack/tree-pattern | A fast, lightweight pattern matcher for tree structures such as an Abstract Syntax Tree (AST). |
| @rushstack/ts-command-line | An object-oriented command-line parser for TypeScript projects. |
| @rushstack/typings-generator | |
| @rushstack/webpack-preserve-dynamic-require-plugin | |
| @rushstack/webpack4-localization-plugin | |
| @rushstack/webpack4-module-minifier-plugin | |
| @rushstack/webpack5-localization-plugin | |
| @rushstack/webpack5-module-minifier-plugin | |
| @rushstack/worker-pool |