Interface InlineCompletionsProvider<T>

Type Parameters

T extends InlineCompletions = InlineCompletions

Hierarchy

InlineCompletionsProvider

Index

Methods

freeInlineCompletions handleItemDidShow? handlePartialAccept? provideInlineCompletions

Methods

freeInlineCompletions

freeInlineCompletions(completions: T): void
Will be called when a completions list is no longer in use and can be garbage-collected.
Parameters
- completions: T
Returns void
- Defined in editor.api.d.ts:7114

`Optional` handleItemDidShow

handleItemDidShow(completions: T, item: T["items"][number], updatedInsertText: string): void
Will be called when an item is shown.
Parameters
- completions: T
- item: T["items"][number]
- updatedInsertText: string
  
  Is useful to understand bracket completion.
Returns void
- Defined in editor.api.d.ts:7106

`Optional` handlePartialAccept

handlePartialAccept(completions: T, item: T["items"][number], acceptedCharacters: number): void
Will be called when an item is partially accepted.
Parameters
- completions: T
- item: T["items"][number]
- acceptedCharacters: number
Returns void
- Defined in editor.api.d.ts:7110

provideInlineCompletions

provideInlineCompletions(model: ITextModel, position: Position, context: InlineCompletionContext, token: CancellationToken): ProviderResult<T>
Parameters
- model: ITextModel
- position: Position
- context: InlineCompletionContext
- token: CancellationToken
Returns ProviderResult<T>
- Defined in editor.api.d.ts:7101