Class CompletionProvider

constructor

• new CompletionProvider(
      initialPosition?: { pos: Point; prefix: string },
  ): CompletionProvider

• Parameters

  • OptionalinitialPosition: { pos: Point; prefix: string }

  Returns CompletionProvider

active

completers

completions

initialPosition

detach

• detach(): void

• Returns void

gatherCompletions

• gatherCompletions(editor: Editor, callback: CompletionCallbackFunction): boolean

• Parameters

  • editor: Editor
  • callback: CompletionCallbackFunction

  Returns boolean

insertByIndex

• insertByIndex(
      editor: Editor,
      index: number,
      options?: CompletionProviderOptions,
  ): boolean

• Parameters

  • editor: Editor
  • index: number
  • Optionaloptions: CompletionProviderOptions

  Returns boolean

insertMatch

• insertMatch(
      editor: Editor,
      data: Completion,
      options?: CompletionProviderOptions,
  ): boolean

• Parameters

  • editor: Editor
  • data: Completion
  • Optionaloptions: CompletionProviderOptions

  Returns boolean

provideCompletions

• provideCompletions(
      editor: Editor,
      options: CompletionProviderOptions,
      callback: (
          err: Error,
          completions: FilteredList | [],
          finished: boolean,
      ) => void,
  ): 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: Error, completions: FilteredList | [], finished: boolean) => void

  Returns void