rush-lib.icustomtipinfo.md

hide_title	true
custom_edit_url
pagination_prev
pagination_next

Home > @microsoft/rush-lib > ICustomTipInfo

ICustomTipInfo interface

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.

Metadata for a custom tip.

Signature:

export interface ICustomTipInfo 

Remarks

This differs from the ICustomTipItemJson interface in that these are not configurable by the user; it's the inherent state of a custom tip. For example, the custom tip for ERR_PNPM_NO_MATCHING_VERSION has a inherent severity of Error<></>, and a inherent match function that rush maintainer defines.

Properties

Property	Modifiers	Type	Description
isMatch?		(str: string) => boolean	(BETA) (Optional) The function to determine how to match this tipId.
severity		CustomTipSeverity	(BETA) The severity of the custom tip. It will determine the printing severity ("Error" = red, "Warning" = yellow, "Info" = normal).
tipId		CustomTipId	(BETA)
type		CustomTipType	(BETA) The type of the custom tip.