Theia API Documentation v1.67.0
    Preparing search index...

    Function registerTerminalCompletionProvider

    • Register a completion provider for terminals.

      Type Parameters

      Parameters

      • provider: TerminalCompletionProvider<T>

        The completion provider.

      • ...triggerCharacters: string[]

        Optional characters that trigger completion. When any of these characters is typed, the completion provider will be invoked. For example, passing '-' would cause the provider to be invoked whenever the user types a dash character.

      Returns Disposable

      A Disposable that unregisters this provider when being disposed.

      window.registerTerminalCompletionProvider({
      provideTerminalCompletions(terminal, context) {
      return new TerminalCompletionList([
      { label: '--version', replacementRange: [Math.max(0, context.cursorPosition - 2), context.cursorPosition] }
      ]);
      }
      });
      window.registerTerminalCompletionProvider({
      provideTerminalCompletions(terminal, context) {
      return new TerminalCompletionList([
      { label: '--help', replacementRange: [Math.max(0, context.cursorPosition - 2), context.cursorPosition] }
      ]);
      }
      }, '-');