RoadmapShopEvents
Skip to main content

Home > @microsoft/rush-lib > BuildCacheConfiguration > loadAndRequireEnabledAsync

BuildCacheConfiguration.loadAndRequireEnabledAsync() method

This API is provided as a preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Loads the build-cache.json data from the standard file path common/config/rush/build-cache.json. If the file has not been created yet, or if the feature is not enabled, then an error is reported.

Signature:

static loadAndRequireEnabledAsync(terminal: ITerminal, rushConfiguration: RushConfiguration, rushSession: RushSession): Promise<BuildCacheConfiguration>;

Parameters

ParameterTypeDescription
terminalITerminal
rushConfigurationRushConfiguration
rushSessionRushSession

Returns:

Promise<BuildCacheConfiguration>