Getting Started
Writing content
API Documentation
Customization
Recipes
API References Develop
@ng-doc/app / Function

provideSearchEngine

Generic types:E

Provides the NgDocSearchEngine to enable search in the documentation.

You can create and provide your own NgDocSearchEngine if you want to handle the search yourself.

Presentation

function provideSearchEngine(
  engine: E,
  args: ConstructorParameters<E>,
): Provider;

Returns

Provider -

The provider for the search engine.

Parameters

NameTypeDescription
engine
E

The search engine class.

args
ConstructorParameters<E>

The arguments for the search engine class.