Class CompletionProvider

constructor

• new CompletionProvider(initialPosition?): CompletionProvider

• Parameters

  • Optional initialPosition: {
        pos: Point;
        prefix: string;
    }

    • pos: Point

    • prefix: string

  Returns CompletionProvider

active

completers

initialPosition

$insertString

• $insertString(editor, data): void

• Parameters

  • editor: Editor

  • data: Completion

  Returns void

detach

• detach(): void

• Returns void

gatherCompletions

• gatherCompletions(editor, callback): boolean

• Parameters

  • editor: Editor

  • callback: CompletionCallbackFunction

  Returns boolean

insertByIndex

• insertByIndex(editor, index, options?): boolean

• Parameters

  • editor: Editor

  • index: number

  • Optional options: CompletionProviderOptions

  Returns boolean

insertMatch

• insertMatch(editor, data, options?): boolean

• Parameters

  • editor: Editor

  • data: Completion

  • Optional options: CompletionProviderOptions

  Returns boolean

provideCompletions

• provideCompletions(editor, options, callback): void

• This is the entry point to the class, it gathers, then provides the completions asynchronously via callback. The callback function may be called multiple times, the last invokation is marked with a finished flag

  Parameters

  • editor: Editor

  • options: CompletionProviderOptions

  • callback: ((err, completions, finished) => void)

    • • (err, completions, finished): void

      • Parameters

        • err: Error

        • completions: [] | FilteredList

        • finished: boolean

        Returns void

  Returns void