Interface IModel

Model for inline completions.

interface IModel {
    completions: null | IInlineCompletionList<IInlineItem>;
    cursor: IPosition;
    filterTextChanged: ISignal<InlineCompleter.IModel, IndexMap>;
    isDisposed: boolean;
    provisionProgress: ISignal<InlineCompleter.IModel, IProvisionProgress>;
    suggestionsChanged: ISignal<InlineCompleter.IModel, ISuggestionsChangedArgs>;
    appendCompletions(reply): void;
    dispose(): void;
    handleSelectionChange(range): void;
    handleTextChange(change): void;
    notifyProgress(providerProgress): void;
    reset(): void;
    setCompletions(reply): void;
}

Hierarchy

Implemented by

Properties

completions cursor filterTextChanged isDisposed provisionProgress suggestionsChanged

Methods

appendCompletions dispose handleSelectionChange handleTextChange notifyProgress reset setCompletions

Properties

Readonly completions

completions: null | IInlineCompletionList<IInlineItem>

Current inline completions.

cursor

cursor: IPosition

Original placement of cursor.

Readonly filterTextChanged

filterTextChanged: ISignal<InlineCompleter.IModel, IndexMap>

A signal emitted when filter text is updated. Emits a mapping from old to new index for items after filtering.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

Readonly provisionProgress

provisionProgress: ISignal<InlineCompleter.IModel, IProvisionProgress>

A signal emitted when new information about progress is available.

Readonly suggestionsChanged

suggestionsChanged: ISignal<InlineCompleter.IModel, ISuggestionsChangedArgs>

A signal emitted when new suggestions are set on the model.

Methods

appendCompletions

dispose

  • dispose(): void

  • Dispose of the resources held by the object.

    Notes

    If the object's dispose method is called more than once, all calls made after the first will be a no-op.

    Undefined Behavior

    It is undefined behavior to use any functionality of the object after it has been disposed unless otherwise explicitly noted.

    Returns void

handleSelectionChange

handleTextChange

notifyProgress

reset

setCompletions

Settings

Member Visibility

Theme

On This Page

completionscursorfilterTextChangedisDisposedprovisionProgresssuggestionsChangedappendCompletionsdisposehandleSelectionChangehandleTextChangenotifyProgressresetsetCompletions