Interface SnippetOptions

interface SnippetOptions {
    highlight?: boolean;
    size?: number;
    stemmer?: Language;
    stopwords?: Language;
}

Properties

highlight?: boolean

Whether to highlight terms using elements. Defaults to false.

size?: number

Maximum number of characters the snippet may be.

stemmer?: Language

Stemmer to use when comparing query terms with text terms.

stopwords?: Language

Lists of stopwords to ignore while finding the best snippet.