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

NgDocDefaultSearchEngine

Search engine for the documentation, it loads the index and provides a search method.

Constructor

No documentation has been provided.

Presentation
constructor(
	private options?: NgDocDefaultSearchEngineOptions | undefined
): NgDocDefaultSearchEngine;
Parameters
NameTypeDescription
options
NgDocDefaultSearchEngineOptions | undefined

Methods

Search the documentation for the given query.

Presentation
search(query: string): Observable<NgDocSearchResult[]>;
Parameters
NameTypeDescription
query
string

The query to search for.

Returns