Class SearchProviderRegistry

Search provider registry

Implements

ISearchProviderRegistry

Index

Constructors

Properties

Accessors

Methods

add getProvider hasProvider

Constructors

constructor

new SearchProviderRegistry(translator?: ITranslator): SearchProviderRegistry
Constructor
Parameters
- translator: ITranslator = nullTranslator
  Application translator object
Returns SearchProviderRegistry
- Defined in packages/documentsearch/src/searchproviderregistry.ts:23

Properties

`Protected`translator

translator: ITranslator = nullTranslator

Application translator object

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/src/searchproviderregistry.ts:79

Methods

add

add<T extends Widget = Widget>(
key: string,
provider: ISearchProviderFactory<T>,
): 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/src/searchproviderregistry.ts:31

getProvider

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

hasProvider

hasProvider(widget: 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/src/searchproviderregistry.ts:66