Skip to content
@ng-doc/app / Interface

NgDocDefaultSearchEngineOptions

Options for the NgDocDefaultSearchEngine.

DeclarationTypeScript
export interface NgDocDefaultSearchEngineOptions { … }

Members

Properties

4
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). Guides get up to half of them, and more when fewer API references match; API references fill the rest.

stemmer?: ((word: string) => string) | undefined

The language to use for the search engine. See https://www.npmjs.com/package/@orama/stemmers for available languages

tolerance?: number | undefined

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

Symbol
Kind
Interface
Scope
@ng-doc/app
Edit this page