Type Alias BaseCompletion

BaseCompletion: {
    caption?: string;
    command?: any;
    completer?: Completer;
    completerId?: string;
    docHTML?: string;
    docText?: string;
    hideInlinePreview?: boolean;
    meta?: string;
    range?: IRange;
    score?: number;
    skipFilter?: boolean;
    snippet?: string;
    value?: string;
}

Type declaration

  • Optionalcaption?: string
    • the text that would be displayed in the completion list. If omitted, value or snippet would be shown instead.
  • Optionalcommand?: any
    • A command to be executed after the completion is inserted (experimental)
  • Optionalcompleter?: Completer
  • OptionalcompleterId?: string
    • the identifier of the completer
  • OptionaldocHTML?: string
    • an HTML string that would be displayed as an additional popup
  • OptionaldocText?: string
    • a plain text that would be displayed as an additional popup. If docHTML exists, it would be used instead of docText.
  • OptionalhideInlinePreview?: boolean
  • Optionalmeta?: string
    • a short description of the completion
  • Optionalrange?: IRange
    • An object specifying the range of text to be replaced with the new completion value (experimental)
  • Optionalscore?: number
    • a numerical value that determines the order in which completions would be displayed. A lower score means that the completion would be displayed further from the start
  • OptionalskipFilter?: boolean
    • a boolean value to decide if the popup item is going to skip the filtering process done using prefix text.
  • Optionalsnippet?: string
    • a text snippet that would be inserted when the completion is selected
  • Optionalvalue?: string
    • The text that would be inserted when selecting this completion.

Settings

Member Visibility