Interface: ITextSearchOptions

Options to configure a text search

Properties

caseSensitive?

optionalcaseSensitive: boolean

Indicates whether the search should be case sensitive. (Defaults to false.)

---

direction?

optionaldirection: TextSearchDirection

The direction to search through the text in (Defaults to down.)

---

normalizeAccentsForSearch?

optionalnormalizeAccentsForSearch: boolean

Controls whether all search features normalize accented characters to their base form in both the searchable raw text and the provided search terms. This option is applied to all search modes. (Defaults to false.)

---

normalizeEmoji?

optionalnormalizeEmoji: boolean

Controls whether all search features normalize emoticons and emoji short names to emoji unicode values in both the searchable raw text and the provided search terms. This option is applied to all search modes. (Defaults to false.)

---

searchMode?

optionalsearchMode: TextSearchUtilityMode

The text search mode to use (Defaults to string mode.) This determines how the search expression is interpreted.

---

start?

optionalstart: number

The character index to begin searching at within the text being searched (Defaults to 0 if the direction is set to TextSearchDirection.Down and defaults to the index of the end of the text being searched if the direction is set to TextSearchDirection.Up.)

---

stemAll?

optionalstemAll: boolean

Determines whether all words will be treated as stems or only words with the ~ stem operator (Defaults to false.)

---

stemmer?

optionalstemmer: TextSearchUtilityStemmer

Determines which stemming algorithm will be used (Defaults to none.)