Class CompletionProvider

constructor

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

  Parameters

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

  Returns CompletionProvider

active

completers

initialPosition

$insertString

• $insertString(editor: Editor, data: Completion): void

  Parameters

  • editor: Editor
  • data: Completion

  Returns void

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?: Ace.CompletionProviderOptions,
  ): boolean

  Parameters

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

  Returns boolean

insertMatch

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

  Parameters

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

  Returns boolean

provideCompletions

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

  Returns void