Skip to content

Latest commit

 

History

History
23 lines (15 loc) · 1.06 KB

search-core.spellcheck.md

File metadata and controls

23 lines (15 loc) · 1.06 KB

Home > @yext/search-core > SpellCheck

SpellCheck interface

A spellcheck response from a search query.

Signature:

export interface SpellCheck 

Properties

Property 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.