Home > @microsoft/rush-lib > CustomTipsConfiguration > customTipRegistry

CustomTipsConfiguration.customTipRegistry property

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.

A registry mapping custom tip IDs to their corresponding metadata.

Signature:

static customTipRegistry: Readonly<Record<CustomTipId, ICustomTipInfo>>;

Remarks

This registry is used to look up metadata for custom tips based on their IDs. The metadata includes information such as the severity level, the type of tip, and an optional matching function.

Each key in the registry corresponds to a CustomTipIdEnum value, and each value is an object implementing the ICustomTipInfo interface.

Example

const tipInfo = CustomTipsConfiguration.customTipRegistry[CustomTipIdEnum.TIP_RUSH_INCONSISTENT_VERSIONS];
console.log(tipInfo.severity);  // Output: CustomTipSeverity.Error

See CustomTipId for the list of custom tip IDs. See ICustomTipInfo for the structure of the metadata.