CompletionItemProvider<T extends CompletionItem> class

The completion item provider interface defines the contract between extensions and IntelliSense.

Providers can delay the computation of the {@linkcode CompletionItem.detaildetail} and {@linkcode CompletionItem.documentationdocumentation} properties by implementing the {@linkcode CompletionItemProvider.resolveCompletionItemresolveCompletionItem}-function. However, properties that are needed for the initial sorting and filtering, like sortText, filterText, insertText, and range, must not be changed during resolve.

Providers are asked for completions either explicitly by a user gesture or -depending on the configuration- implicitly when typing words or trigger characters.

Available extensions
Annotations
  • @JS()
  • @staticInterop
  • @anonymous

Properties

hashCode int
The hash code for this object.
no setterinherited
provideCompletionItems FutureOr<Object> Function(TextDocument, Position, CancellationToken, CompletionContext)

Available on CompletionItemProvider<T>, provided by the CompletionItemProvider$Typings extension

getter/setter pair
resolveCompletionItem FutureOr<T> Function(T, CancellationToken)

Available on CompletionItemProvider<T>, provided by the CompletionItemProvider$Typings extension

getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited