Interface IAutocompleteAdapter

Abstract autocomplete adapter interface built on top of the lookup adapter contract (see frontend/adapters/abstract-autocomplete-adapter.ts).

interface IAutocompleteAdapter {
    sourceID?: string;
    supportedPattern?: RegExp;
    updateCallback?: Function | UpdateCallback;
    ask(url: string): boolean;
    getSourceID(): string;
    lookup(url: string): Promise<LookupResult>;
    removeAutocomplete(): void;
    runAutocomplete(): void;
    setupAutocomplete(): void;
}

Hierarchy (View Summary)

ILookupAdapter
- IAutocompleteAdapter

Index

Properties

sourceID? supportedPattern? updateCallback?

Methods

ask getSourceID lookup removeAutocomplete? runAutocomplete? setupAutocomplete?

Properties

`Optional`sourceID

sourceID?: string

`Optional`supportedPattern

supportedPattern?: RegExp

`Optional`updateCallback

updateCallback?: Function | UpdateCallback

Methods

ask

ask(url: string): boolean
Parameters
- url: string
Returns boolean
Inherited from ILookupAdapter.ask
- Defined in types/frontend/adapters.d.ts:65

getSourceID

getSourceID(): string
Returns string
Inherited from ILookupAdapter.getSourceID
- Defined in types/frontend/adapters.d.ts:67

lookup

lookup(url: string): Promise<LookupResult>
Parameters
- url: string
Returns Promise<LookupResult>
Inherited from ILookupAdapter.lookup
- Defined in types/frontend/adapters.d.ts:66

`Optional`removeAutocomplete

removeAutocomplete(): void
Returns void
- Defined in types/frontend/adapters.d.ts:76

`Optional`runAutocomplete

runAutocomplete(): void
Returns void
- Defined in types/frontend/adapters.d.ts:77

`Optional`setupAutocomplete

setupAutocomplete(): void
Returns void
- Defined in types/frontend/adapters.d.ts:75