API Reference
Packages
Package | Description |
|---|---|
API Documenter generates an API reference website from the .api.json files created by API Extractor. The | |
API Extractor helps with validation, documentation, and reviewing of the exported API for a TypeScript library. The | |
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. | |
A library for writing scripts that interact with the Rush tool. | |
Execute shell commands using a consistent syntax on every platform. | |
This simple loader wraps the loading of CSS in script equivalent to require("@microsoft/load-themed-styles").loadStyles('... css text ...'). | |
This package is used to manage persistent, per-user cached credentials. | |
This package is used to manage debug certificates for development servers. This package provides the following utilities:
| |
Heft is a config-driven toolchain that invokes other popular tools such as TypeScript, ESLint, Jest, Webpack, and API Extractor. You can use it to build web applications, Node.js services, command-line tools, libraries, and more. | |
A library for loading config files for use with the Heft build system. | |
Some utilities for working with Rush Stack localization files. | |
Strongly typed trie data structure for path and URL-like strings. | |
API for use by MCP plugins. | |
This library wraps terser in convenient handles for parallelization. It powers | |
Core libraries that every NodeJS toolchain project should use. | |
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. | |
Run a Playwright browser server in one environment and drive it from another environment by forwarding Playwright's WebSocket traffic through a tunnel. | |
Parse VS Code style problem matcher definitions and use them to extract structured problem reports from strings. | |
A system for sharing tool configurations between projects without duplicating config files. | |
This library enables a tool to display live console output from multiple concurrent processes, while ensuring that their output does not get jumbled together. | |
This library implements a system for processing human readable text that will be output by console applications. | |
A fast, lightweight pattern matcher for tree structures such as an Abstract Syntax Tree (AST). | |
An object-oriented command-line parser for TypeScript projects. | |
An engine for generating TypeScript .d.ts files that provide type signatures for non-TypeScript modules such as generated JavaScript or CSS. It can operate in either a single-run mode or a watch mode. | |
A webpack plugin for generating a list of embedded dependencies. Embedded dependencies are third-party packages which are being bundled into your released code and are often times subject to license, security, and other legal requirements. This plugin aims to make it easier to generate a list of embedded dependencies and their associated metadata, so they can be analyzed by additional tools. | |
Utility package which provides a set of tools for working in webpack plugins, loaders, and other integrations. | |
A lightweight worker pool implementation using the NodeJS |