search-core.spellcheck.md

Home > @yext/search-core > SpellCheck

SpellCheck interface

A spellcheck response from a search query.

Signature:

export interface SpellCheck 

Properties

Property	Modifiers	Type	Description
correctedQuery		string	The corrected version of the originalQuery.
matchedSubstrings		{ length: number; offset: number; }[]	An array of substring matches which correspond to the highlighting. Offset indicates the index of the match, and the length indicates the number of characters of the match.
originalQuery		string	The query that was input into the spell checker.
type		SpellCheckType	The type of spell check.