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 12, 2022
1 parent 8b448ae commit ff0f326
Show file tree
Hide file tree
Showing 7 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/search-headless.headlessconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## HeadlessConfig type

The configuration for an SearchHeadless instance.
The configuration for a SearchHeadless instance.

<b>Signature:</b>

Expand Down
4 changes: 2 additions & 2 deletions docs/search-headless.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@
| [SpellCheckState](./search-headless.spellcheckstate.md) | Maintains whether spellcheck is enabled and the spellcheck response from the latest search. |
| [State](./search-headless.state.md) | The state representing a SearchHeadless instance. |
| [StateListener](./search-headless.statelistener.md) | Represents a listener for a specific value of type T in the state. |
| [StateManager](./search-headless.statemanager.md) | Manages the information contained in the state for an SearchHeadless instance. |
| [StateManager](./search-headless.statemanager.md) | Manages the information contained in the state for a SearchHeadless instance. |
| [UniversalAutocompleteRequest](./search-headless.universalautocompleterequest.md) | Options for a universal autocomplete request. |
| [UniversalLimit](./search-headless.universallimit.md) | The maximum limit of results per vertical. Each limit can be set from 1-50, inclusive. |
| [UniversalSearchRequest](./search-headless.universalsearchrequest.md) | Options which can be specified for a universal search. |
Expand Down Expand Up @@ -141,7 +141,7 @@
| [Context](./search-headless.context.md) | Used to trigger Answers [Query Rules](https://hitchhikers.yext.com/tracks/answers-advanced/ans302-query-rules/)<!-- -->. |
| [EnumOrLiteral](./search-headless.enumorliteral.md) | Produces a union type from the enum passed as a generic which consists of the enum values and the string literals of the enum. |
| [FilterTypes](./search-headless.filtertypes.md) | A union type for the different kinds of filter. |
| [HeadlessConfig](./search-headless.headlessconfig.md) | The configuration for an SearchHeadless instance. |
| [HeadlessConfig](./search-headless.headlessconfig.md) | The configuration for a SearchHeadless instance. |
| [HighlightedFields](./search-headless.highlightedfields.md) | A mapping of fields to the values emphasized by the Answers API |
| [SearchType](./search-headless.searchtype.md) | An enum and its corresponding string literals which indicate the type of search that Headless is managing. |

2 changes: 1 addition & 1 deletion docs/search-headless.querystate.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ export interface QueryState
| [input?](./search-headless.querystate.input.md) | string | <i>(Optional)</i> The user input used for the next search query. |
| [mostRecentSearch?](./search-headless.querystate.mostrecentsearch.md) | string | <i>(Optional)</i> The query of the most recent search. |
| [queryId?](./search-headless.querystate.queryid.md) | string | <i>(Optional)</i> The ID of the query from the latest search. |
| [querySource?](./search-headless.querystate.querysource.md) | [QuerySource](./search-headless.querysource.md) | <i>(Optional)</i> The source of the query (from a standard Search integration, an Search overlay, or from visual autocomplete). |
| [querySource?](./search-headless.querystate.querysource.md) | [QuerySource](./search-headless.querysource.md) | <i>(Optional)</i> The source of the query (from a standard Search integration, a Search overlay, or from visual autocomplete). |
| [queryTrigger?](./search-headless.querystate.querytrigger.md) | [QueryTrigger](./search-headless.querytrigger.md) | <i>(Optional)</i> How the query was triggered (besides user input). |
| [searchIntents?](./search-headless.querystate.searchintents.md) | [SearchIntent](./search-headless.searchintent.md)<!-- -->\[\] | <i>(Optional)</i> The computed intents of the mostRecentSearch, as returned by the Search API. |

2 changes: 1 addition & 1 deletion docs/search-headless.querystate.querysource.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## QueryState.querySource property

The source of the query (from a standard Search integration, an Search overlay, or from visual autocomplete).
The source of the query (from a standard Search integration, a Search overlay, or from visual autocomplete).

<b>Signature:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/search-headless.searchheadless.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export default class SearchHeadless
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [state](./search-headless.searchheadless.state.md) | | [State](./search-headless.state.md) | Gets the current state of the SearchHeadless instance. |
| [utilities](./search-headless.searchheadless.utilities.md) | | typeof answersUtilities | Common utility functions for manipulating Search-related data. |
| [utilities](./search-headless.searchheadless.utilities.md) | | typeof searchUtilities | Common utility functions for manipulating Search-related data. |

## Methods

Expand Down
2 changes: 1 addition & 1 deletion docs/search-headless.searchheadless.utilities.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,5 +9,5 @@ Common utility functions for manipulating Search-related data.
<b>Signature:</b>

```typescript
readonly utilities: typeof answersUtilities;
readonly utilities: typeof searchUtilities;
```
2 changes: 1 addition & 1 deletion docs/search-headless.statemanager.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## StateManager interface

Manages the information contained in the state for an SearchHeadless instance.
Manages the information contained in the state for a SearchHeadless instance.

<b>Signature:</b>

Expand Down

0 comments on commit ff0f326

Please sign in to comment.