Interface BaseCompletion

interface BaseCompletion {
    caption: string;
    command: string;
    completer: Completer & {
        insertMatch: ((editor, data) => void);
    };
    completerId: string;
    docHTML: string;
    docText: string;
    hideInlinePreview: boolean;
    meta: string;
    range: IRange;
    score: number;
    snippet: string;
    value: string;
}

Properties

caption command completer completerId docHTML docText hideInlinePreview meta range score snippet value

Properties

caption

caption: string

the text that would be displayed in the completion list. If omitted, value or snippet would be shown instead.

command

command: string

A command to be executed after the completion is inserted (experimental)

completer

completer: Completer & {
    insertMatch: ((editor, data) => void);
}

Type declaration

  • insertMatch: ((editor, data) => void)
      • (editor, data): void

      • Parameters

        Returns void

completerId

completerId: string

the identifier of the completer

docHTML

docHTML: string

an HTML string that would be displayed as an additional popup

docText

docText: string

a plain text that would be displayed as an additional popup. If docHTML exists, it would be used instead of docText.

hideInlinePreview

hideInlinePreview: boolean

meta

meta: string

a short description of the completion

range

range: IRange

An object specifying the range of text to be replaced with the new completion value (experimental)

score

score: 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

snippet

snippet: string

a text snippet that would be inserted when the completion is selected

value

value: string

The text that would be inserted when selecting this completion.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc