Rush StackShopBlogEvents
Skip to main content

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/loader-load-themed-styles

@microsoft/rush-lib

A library for writing scripts that interact with the Rush tool.

@microsoft/rushell

Execute shell commands using a consistent syntax on every platform.

@microsoft/webpack5-load-themed-styles-loader

This simple loader wraps the loading of CSS in script equivalent to require("@microsoft/load-themed-styles").loadStyles('... css text ...').

@rushstack/credential-cache

This package is used to manage persistent, per-user cached credentials.

@rushstack/debug-certificate-manager

This package is used to manage debug certificates for development servers.

This package provides the following utilities:

  • CertificateStore to handle retrieving and saving a debug certificate.

  • CertificateManager is a utility class containing the following public methods:

  • ensureCertificate will find or optionally create a debug certificate and trust it.

  • untrustCertificate will untrust a debug certificate.

@rushstack/heft

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.

@rushstack/heft-config-file

A library for loading config files for use with the Heft build system.

@rushstack/localization-utilities

Some utilities for working with Rush Stack localization files.

@rushstack/lookup-by-path

Strongly typed trie data structure for path and URL-like strings.

@rushstack/mcp-server

API for use by MCP plugins.

@rushstack/module-minifier

This library wraps terser in convenient handles for parallelization. It powers @rushstack/webpack4-module-minifier-plugin and @rushstack/webpack5-module-minifier-plugin but has no coupling with webpack.

@rushstack/node-core-library

Core libraries that every NodeJS toolchain project should use.

@rushstack/operation-graph

@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/package-extractor

@rushstack/playwright-browser-tunnel

Run a Playwright browser server in one environment and drive it from another environment by forwarding Playwright's WebSocket traffic through a tunnel.

@rushstack/problem-matcher

Parse VS Code style problem matcher definitions and use them to extract structured problem reports from strings.

@rushstack/rig-package

A system for sharing tool configurations between projects without duplicating config files.

@rushstack/rush-pnpm-kit-v10

@rushstack/rush-pnpm-kit-v8

@rushstack/rush-pnpm-kit-v9

@rushstack/set-webpack-public-path-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

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.

@rushstack/webpack-embedded-dependencies-plugin

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.

@rushstack/webpack-plugin-utilities

Utility package which provides a set of tools for working in webpack plugins, loaders, and other integrations.

@rushstack/worker-pool

A lightweight worker pool implementation using the NodeJS worker_threads API.