Interface ISearchProviderFactory<T>

Interface for search provider factory

Type Parameters

Hierarchy

  • ISearchProviderFactory

Properties

Properties

createNew: ((widget, translator?) => ISearchProvider)

Type declaration

    • (widget, translator?): ISearchProvider
    • Instantiate a search provider for the widget.

      Notes

      The widget provided is always checked using isApplicable before calling this factory.

      Parameters

      • widget: T

        The widget to search on

      • Optional translator: ITranslator

        [optional] The translator object

      Returns ISearchProvider

      The search provider on the widget

isApplicable: ((domain) => domain is T)

Type declaration

    • (domain): domain is T
    • Report whether or not this provider has the ability to search on the given widget. The function is a type guard, meaning that it returns a boolean, but has a type predicate (x is T) for its return signature.

      Parameters

      • domain: Widget

        Widget to test

      Returns domain is T

Generated using TypeDoc