Home > @rushstack/heft > HeftConfiguration

HeftConfiguration class

Signature:

export declare class HeftConfiguration 

Properties

Property	Modifiers	Type	Description
buildFolderPath	readonly	string	Project build folder path. This is the folder containing the project's package.json file.
globalTerminal	readonly	ITerminal	Terminal instance to facilitate logging.
heftPackageJson	readonly	IPackageJson	The Heft tool's package.json
numberOfCores	readonly	number	The number of CPU cores available to the process. This can be used to determine how many tasks can be run in parallel.
projectConfigFolderPath	readonly	string	The path to the project's "config" folder.
projectPackageJson	readonly	IPackageJson	The package.json of the project being built
rigConfig	readonly	IRigConfig	The rig.json configuration for this project, if present.
rigPackageResolver	readonly	IRigPackageResolver	The rig package resolver, which can be used to rig-resolve a requested package.
slashNormalizedBuildFolderPath	readonly	string	HeftConfiguration.buildFolderPath with all path separators converted to forward slashes.
tempFolderPath	readonly	string	The project's temporary folder.
terminalProvider	readonly	ITerminalProvider	Terminal provider for the provided terminal.

Methods

Method	Modifiers	Description
tryLoadProjectConfigurationFile(options, terminal)		Attempts to load a riggable project configuration file using blocking, synchronous I/O.
tryLoadProjectConfigurationFileAsync(options, terminal)		Attempts to load a riggable project configuration file using asynchronous I/O.