Class SearchProviderRegistry

Search provider registry

Hierarchy

SearchProviderRegistry

Implements

ISearchProviderRegistry

Index

Constructors

Properties

_changed _providerMap translator

Accessors

Methods

add getProvider hasProvider

Constructors

constructor

new SearchProviderRegistry(translator?): SearchProviderRegistry
Constructor
Parameters
- Optional translator: ITranslator
  
  Application translator object
Returns SearchProviderRegistry
- Defined in packages/documentsearch/lib/searchproviderregistry.d.ts:16

Properties

`Private` _changed

_changed: any

`Private` _providerMap

_providerMap: any

`Protected` translator

translator: ITranslator

Accessors

changed

get changed(): ISignal<this, void>
Signal that emits when a new search provider has been registered or removed.

Returns ISignal<this, void>
Implementation of ISearchProviderRegistry.changed
- Defined in packages/documentsearch/lib/searchproviderregistry.d.ts:42

Methods

add

add<T>(key, provider): IDisposable
Add a provider to the registry.
Type Parameters
- T extends Widget = Widget
Parameters
- key: string
  
  The provider key.
- provider: ISearchProviderFactory<T>
Returns IDisposable
A disposable delegate that, when disposed, deregisters the given search provider
Implementation of ISearchProviderRegistry.add
- Defined in packages/documentsearch/lib/searchproviderregistry.d.ts:23

getProvider

getProvider(widget): ISearchProvider
Returns a matching provider for the widget.
Parameters
- widget: Widget
  
  The widget to search over.
Returns ISearchProvider
the search provider, or undefined if none exists.
Implementation of ISearchProviderRegistry.getProvider
- Defined in packages/documentsearch/lib/searchproviderregistry.d.ts:30

hasProvider

hasProvider(widget): boolean
Whether the registry as a matching provider for the widget.
Parameters
- widget: Widget
  
  The widget to search over.
Returns boolean
Provider existence
Implementation of ISearchProviderRegistry.hasProvider
- Defined in packages/documentsearch/lib/searchproviderregistry.d.ts:37

Generated using TypeDoc