ApprovedPackagesConfiguration | This represents the JSON file specified via the "approvedPackagesFile" option in rush.json. |
ApprovedPackagesItem | An item returned by ApprovedPackagesConfiguration |
ApprovedPackagesPolicy | This is a helper object for RushConfiguration. It exposes the "approvedPackagesPolicy" feature from rush.json. |
BuildCacheConfiguration | (BETA) Use this class to load and save the "common/config/rush/build-cache.json" config file. This file provides configuration options for cached project build output. |
ChangeManager | A class that helps with programmatically interacting with Rush's change files. |
CommonVersionsConfiguration | Use this class to load and save the "common/config/rush/common-versions.json" config file. This config file stores dependency version information that affects all projects in the repo. |
CredentialCache | (BETA) |
EnvironmentConfiguration | (BETA) Provides Rush-specific environment variable data. All Rush environment variables must start with "RUSH_". This class is designed to be used by RushConfiguration. |
EventHooks | (BETA) This class represents Rush event hooks configured for this repo. Hooks are customized script actions that Rush executes when specific events occur. The actions are expressed as a command-line that is executed using the operating system shell. |
ExperimentsConfiguration | Use this class to load the "common/config/rush/experiments.json" config file. This file allows repo maintainers to enable and disable experimental Rush features. |
FileSystemBuildCacheProvider | (BETA) A build cache provider using the local file system. Required by all cloud cache providers. |
IndividualVersionPolicy | This policy indicates all related projects get version bump driven by their own changes. |
LockStepVersionPolicy | This policy indicates all related projects should use the same version. |
LookupByPath | (BETA) This class is used to associate POSIX relative paths, such as those returned by git commands, with entities that correspond with ancestor folders, such as Rush Projects. It is optimized for efficiently locating the nearest ancestor path with an associated value. |
NpmOptionsConfiguration | Options that are only used when the NPM package manager is selected. |
PackageJsonDependency | |
PackageJsonEditor | |
PnpmOptionsConfiguration | Options that are only used when the PNPM package manager is selected. Use this class to load "common/config/rush/pnpm-config.json" file, or, load json from "pnpmOptions" field in "rush.json" for legacy support. |
ProjectChangeAnalyzer | (BETA) |
RepoStateFile | This file is used to track the state of various Rush-related features. It is generated and updated by Rush. |
Rush | General operations for the Rush engine. |
RushConfiguration | This represents the Rush configuration for a repository, based on the "rush.json" configuration file. |
RushConfigurationProject | This represents the configuration of a project that is built by Rush, based on the Rush.json configuration file. |
RushConstants | (BETA) Constants used by the Rush tool. |
RushLifecycleHooks | (BETA) Hooks into the lifecycle of the Rush process invocation that plugins may tap into. |
RushSession | (BETA) |
RushUserConfiguration | (BETA) Rush per-user configuration data. |
VersionPolicyConfiguration | Use this class to load and save the "common/config/rush/version-policies.json" config file. This config file configures how different groups of projects will be published by Rush, and how their version numbers will be determined. |
YarnOptionsConfiguration | Options that are only used when the yarn package manager is selected. |