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

NgDocDefaultSearchEngineOptions

Options for the NgDocDefaultSearchEngine.

Properties

NameTypeDescription
exact
boolean | undefined

If true, finds all the document with an exact match of the term property.

limit
number | undefined

Number of results to return (default: 10).

stemmer
any

The language to use for the search engine.

tolerance
number | undefined

Specifies the maximum distance (following the Levenshtein algorithm) between the term and the searchable property. (doesn't work with exact option)