Home > @microsoft/rush-lib > CustomTipsConfiguration

CustomTipsConfiguration class

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

Used to access the common/config/rush/custom-tips.json config file, which allows repo maintainers to configure extra details to be printed alongside certain Rush messages.

Signature:

export declare class CustomTipsConfiguration 

Constructors

Constructor	Modifiers	Description
(constructor)(configFilePath)		(BETA) Constructs a new instance of the CustomTipsConfiguration class

Properties

Property	Modifiers	Type	Description
customTipRegistry	static	Readonly<Record<CustomTipId, ICustomTipInfo>>	(BETA) A registry mapping custom tip IDs to their corresponding metadata.
providedCustomTipsByTipId	readonly	ReadonlyMap<CustomTipId, ICustomTipItemJson>	(BETA)