Skip to content

Commit

Permalink
Automated update to repo's documentation from github action
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Jul 25, 2022
1 parent d83e400 commit 7f852c4
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 0 deletions.
16 changes: 16 additions & 0 deletions docs/search-core.spellcheck.matchedsubstrings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-core](./search-core.md) &gt; [SpellCheck](./search-core.spellcheck.md) &gt; [matchedSubstrings](./search-core.spellcheck.matchedsubstrings.md)

## SpellCheck.matchedSubstrings property

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.

<b>Signature:</b>

```typescript
matchedSubstrings: {
length: number;
offset: number;
}[];
```
1 change: 1 addition & 0 deletions docs/search-core.spellcheck.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ export interface SpellCheck
| Property | Type | Description |
| --- | --- | --- |
| [correctedQuery](./search-core.spellcheck.correctedquery.md) | string | The corrected version of the originalQuery. |
| [matchedSubstrings](./search-core.spellcheck.matchedsubstrings.md) | { 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](./search-core.spellcheck.originalquery.md) | string | The query that was input into the spell checker. |
| [type](./search-core.spellcheck.type.md) | [SpellCheckType](./search-core.spellchecktype.md) | The type of spell check. |

4 changes: 4 additions & 0 deletions etc/search-core.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -492,6 +492,10 @@ export enum Source {
// @public
export interface SpellCheck {
correctedQuery: string;
matchedSubstrings: {
length: number;
offset: number;
}[];
originalQuery: string;
type: SpellCheckType;
}
Expand Down

0 comments on commit 7f852c4

Please sign in to comment.