Interface ITextSearchQueryOptions

Options object used with ReaderDocumentSearch.createTextQuery.

Hierarchy

ITextSearchQueryOptions

Index

Properties

Properties

Optional ignoreCase

ignoreCase?: boolean

If set to true, character casing is ignored.

For example the query "paris" will match the text "Paris".

default: true

Optional searchResultOptions

searchResultOptions?: ITextSearchResultOptions

Options for search result items.

default: ITextSearchResultOptions

Optional whitespaceMode

whitespaceMode?: TextSearchQueryWhitespaceMode

Controls how whitespace should be treated in the source content. See TextSearchQueryWhitespaceMode for a description of each mode.

default: COLLAPSE

Generated using TypeDoc