Interface: Messages

libs/common/ide/types/Messages.Messages

Implemented by

• FakeMessages
• SpyMessages
• VscodeMessages

Methods

showWarning

▸ showWarning(id, message, ...options): Promise<undefined | string>

Displays a warning message {@link message} to the user along with possible {@link options} for them to select.

Parameters

Name	Type	Description
id	string	Each code site where we issue a warning should have a unique, human readable id for testability, eg "deprecatedPositionInference". This allows us to write tests without tying ourself to the specific wording of the warning message provided in {@link message}.
message	string	The message to display to the user
...options	string[]	A list of options to display to the user. The selected option will be returned by this function

Returns

Promise<undefined | string>

The option selected by the user, or undefined if no option was selected

Defined in

libs/common/ide/types/Messages.ts:18