Interface IModel

The data model backing a code completer widget.

interface IModel {
    current: null | ITextState;
    cursor: null | ICursorSpan;
    isDisposed: boolean;
    original: null | ITextState;
    query: string;
    queryChanged: ISignal<Completer.IModel, IQueryChange>;
    stateChanged: ISignal<Completer.IModel, void>;
    subsetMatch: boolean;
    completionItems(): ICompletionItems;
    createPatch(patch): undefined | IPatch;
    dispose(): void;
    handleCursorChange(change): void;
    handleTextChange(change): void;
    orderedTypes(): string[];
    reset(hard?): void;
    resolveItem(activeIndex): undefined | Promise<null | ICompletionItem>;
    setCompletionItems(items): void;
    typeMap(): TypeMap;
}

Hierarchy

Implemented by

Properties

current cursor isDisposed original query queryChanged stateChanged subsetMatch

Methods

completionItems createPatch dispose handleCursorChange handleTextChange orderedTypes reset resolveItem setCompletionItems typeMap

Properties

current

current: null | ITextState

The current text state details.

cursor

cursor: null | ICursorSpan

The cursor details that the API has used to return matching options.

Readonly isDisposed

isDisposed: boolean

Test whether the object has been disposed.

Notes

This property is always safe to access.

original

original: null | ITextState

The original completer request details.

query

query: string

The query against which items are filtered.

Readonly queryChanged

queryChanged: ISignal<Completer.IModel, IQueryChange>

A signal emitted when query string changes (at invocation, or as user types).

Readonly stateChanged

stateChanged: ISignal<Completer.IModel, void>

A signal emitted when state of the completer model changes.

subsetMatch

subsetMatch: boolean

A flag that is true when the model value was modified by a subset match.

Methods

completionItems

createPatch

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

handleCursorChange

handleTextChange

orderedTypes

reset

  • reset(hard?): void

  • Reset the state of the model and emit a state change signal.

    Parameters

    • Optional hard: boolean

      Reset even if a subset match is in progress.

    Returns void

resolveItem

  • resolveItem(activeIndex): undefined | Promise<null | ICompletionItem>

  • Lazy load missing data of an item.

    Parameters

    Returns undefined | Promise<null | ICompletionItem>

    Return undefined if the completion item with activeIndex index can not be found. Return a promise of null if another resolveItem is called. Otherwise return the promise of resolved completion item.

    Remarks

    Resolving item by index will be deprecated in the next major release.

setCompletionItems

typeMap

Settings

Member Visibility

Theme

On This Page

currentcursorisDisposedoriginalqueryqueryChangedstateChangedsubsetMatchcompletionItemscreatePatchdisposehandleCursorChangehandleTextChangeorderedTypesresetresolveItemsetCompletionItemstypeMap