Interface PureGrammarTextSuggestion

This mirrors monaco-editor completion item structure See https://microsoft.github.io/monaco-editor/api/interfaces/monaco.languages.CompletionItem.html

interface PureGrammarTextSuggestion {
    description?: string;
    documentation?: DocumentationEntry;
    insertText: string;
    text: string;
}

Properties

description? documentation? insertText text

Properties

Optionaldescription

description?: string

Brief description about the suggestion item to enable the users to quickly differentiate between one suggestions from another

Optionaldocumentation

documentation?: DocumentationEntry

Detailed documentation that explains/elaborates the suggestion item.

insertText

insertText: string

A string or snippet that should be inserted when selecting this suggestion.

NOTE: The snippet syntax follows that of monaco-editor See https://code.visualstudio.com/docs/editor/userdefinedsnippets#_create-your-own-snippets

text

text: string

The text label of the suggestion.

Settings

Member Visibility

On This Page

Properties