NgDoc

Getting Started
What is NgDoc? Installation SSR Configuration NEW OPTIONS Migrations
Writing content
Pages and categories UPDATED Blockquotes NEW STYLES Images and embeds NEW Code blocks Mermaid diagrams NEW Nunjucks Demo and Demo Pane Playground Keywords
API Documentation
Auto generation Documenting declarations Rendering API NEW
Customization
Page Skeleton Page Processors Layout Search Themes UPDATED Icons
Recipes
Performance Ignoring file lines
API References Develop
@ng-doc/app / Class

NgDocDefaultSearchEngine

Extends:NgDocSearchEngine

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

implements NgDocSearchEngine

Search the documentation for the given query.

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

@param query The query to search for.

Returns
Observable<NgDocSearchResult[]>
MIT © 2023 Aleksandr Skoropad