Skip to content

Commit

Permalink
Merge branch 'rename-search-imports' of https://github.com/yext/searc…
Browse files Browse the repository at this point in the history
…h-headless into rename-search-imports

merge
.
  • Loading branch information
ElemelonWind committed Jul 12, 2022
2 parents 421a8be + e1948e1 commit 364f8cd
Show file tree
Hide file tree
Showing 9 changed files with 160 additions and 0 deletions.
18 changes: 18 additions & 0 deletions docs/search-headless.answersconfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [AnswersConfig](./search-headless.answersconfig.md)

## AnswersConfig type

> Warning: This API is now obsolete.
>
> AnswersConfig is deprecated and has been replaced by [SearchConfig](./search-headless.searchconfig.md)
>
<b>Signature:</b>

```typescript
export declare type AnswersConfig = SearchConfig;
```
<b>References:</b> [SearchConfig](./search-headless.searchconfig.md)

18 changes: 18 additions & 0 deletions docs/search-headless.answersconfigwithapikey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md)

## AnswersConfigWithApiKey interface

> Warning: This API is now obsolete.
>
> AnswersConfigWithApiKey is deprecated and has been replaced by [SearchConfigWithApiKey](./search-headless.searchconfigwithapikey.md)
>
<b>Signature:</b>

```typescript
export declare interface AnswersConfigWithApiKey extends SearchConfigWithApiKey
```
<b>Extends:</b> [SearchConfigWithApiKey](./search-headless.searchconfigwithapikey.md)
18 changes: 18 additions & 0 deletions docs/search-headless.answersconfigwithtoken.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md)

## AnswersConfigWithToken interface

> Warning: This API is now obsolete.
>
> AnswersConfigWithToken is deprecated and has been replaced by [SearchConfigWithToken](./search-headless.searchconfigwithtoken.md)
>
<b>Signature:</b>

```typescript
export declare interface AnswersConfigWithToken extends SearchConfigWithToken
```
<b>Extends:</b> [SearchConfigWithToken](./search-headless.searchconfigwithtoken.md)
18 changes: 18 additions & 0 deletions docs/search-headless.answerscore.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [AnswersCore](./search-headless.answerscore.md)

## AnswersCore class

> Warning: This API is now obsolete.
>
> AnswersCore is deprecated and has been replaced by [SearchCore](./search-headless.searchcore.md)
>
<b>Signature:</b>

```typescript
export declare class AnswersCore extends SearchCore
```
<b>Extends:</b> [SearchCore](./search-headless.searchcore.md)
18 changes: 18 additions & 0 deletions docs/search-headless.answerserror.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [AnswersError](./search-headless.answerserror.md)

## AnswersError interface

> Warning: This API is now obsolete.
>
> AnswersError is deprecated and has been replaced by [SearchError](./search-headless.searcherror.md)
>
<b>Signature:</b>

```typescript
export declare interface AnswersError extends SearchError
```
<b>Extends:</b> [SearchError](./search-headless.searcherror.md)
18 changes: 18 additions & 0 deletions docs/search-headless.answersrequest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [AnswersRequest](./search-headless.answersrequest.md)

## AnswersRequest interface

> Warning: This API is now obsolete.
>
> AnswersRequest is deprecated and has been replaced by [SearchRequest](./search-headless.searchrequest.md)
>
<b>Signature:</b>

```typescript
export declare interface AnswersRequest extends SearchRequest
```
<b>Extends:</b> [SearchRequest](./search-headless.searchrequest.md)
18 changes: 18 additions & 0 deletions docs/search-headless.baseanswersconfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@yext/search-headless](./search-headless.md) &gt; [BaseAnswersConfig](./search-headless.baseanswersconfig.md)

## BaseAnswersConfig interface

> Warning: This API is now obsolete.
>
> BaseAnswersConfig is deprecated and has been replaced by [BaseSearchConfig](./search-headless.basesearchconfig.md)
>
<b>Signature:</b>

```typescript
export declare interface BaseAnswersConfig extends BaseSearchConfig
```
<b>Extends:</b> [BaseSearchConfig](./search-headless.basesearchconfig.md)
7 changes: 7 additions & 0 deletions docs/search-headless.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@

| Class | Description |
| --- | --- |
| [AnswersCore](./search-headless.answerscore.md) | |
| [SearchCore](./search-headless.searchcore.md) | Provides methods for executing searches, submitting questions, and performing autocompletes. |
| [SearchError](./search-headless.searcherror.md) | Represents an error |
| [SearchHeadless](./search-headless.searchheadless.md) | Provides the functionality for interacting with a Search experience. |
Expand Down Expand Up @@ -48,10 +49,15 @@
| --- | --- |
| [AdditionalHttpHeaders](./search-headless.additionalhttpheaders.md) | AdditionalHttpHeaders allows users to specify additional values for specific HTTP headers. |
| [AllResultsForVertical](./search-headless.allresultsforvertical.md) | Represents all results for the current vertical. |
| [AnswersConfigWithApiKey](./search-headless.answersconfigwithapikey.md) | |
| [AnswersConfigWithToken](./search-headless.answersconfigwithtoken.md) | |
| [AnswersError](./search-headless.answerserror.md) | |
| [AnswersRequest](./search-headless.answersrequest.md) | |
| [AppliedQueryFilter](./search-headless.appliedqueryfilter.md) | A filter that the Search API applied to the search. |
| [AutocompleteResponse](./search-headless.autocompleteresponse.md) | The response of a universal or vertical autocomplete request. |
| [AutocompleteResult](./search-headless.autocompleteresult.md) | An autocomplete suggestion. |
| [AutocompleteService](./search-headless.autocompleteservice.md) | A service for autocomplete requests. |
| [BaseAnswersConfig](./search-headless.baseanswersconfig.md) | |
| [BaseSearchConfig](./search-headless.basesearchconfig.md) | The base configuration options for [SearchCore](./search-headless.searchcore.md)<!-- -->. |
| [BoundedRange](./search-headless.boundedrange.md) | An interface representing a range of values of type T. |
| [ClientSDKHeaderValues](./search-headless.clientsdkheadervalues.md) | Additional agents and their versions used to create the Search experience. The information for these agents is added to the Client-SDK HTTP header along with that of the ANSWERS\_CORE agent. |
Expand Down Expand Up @@ -137,6 +143,7 @@

| Type Alias | Description |
| --- | --- |
| [AnswersConfig](./search-headless.answersconfig.md) | |
| [Context](./search-headless.context.md) | Used to trigger Search [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. |
Expand Down
27 changes: 27 additions & 0 deletions etc/search-headless.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,32 @@ export interface AllResultsForVertical {
resultsCount: number;
}

// @public @deprecated (undocumented)
export type AnswersConfig = SearchConfig;

// @public @deprecated (undocumented)
export interface AnswersConfigWithApiKey extends SearchConfigWithApiKey {
}

// @public @deprecated (undocumented)
export interface AnswersConfigWithToken extends SearchConfigWithToken {
}

// @public @deprecated (undocumented)
export class AnswersCore extends SearchCore {
}

// @public @deprecated (undocumented)
export interface AnswersError extends SearchError {
}

// @public @deprecated (undocumented)
export const AnswersHeadless: typeof SearchHeadless;

// @public @deprecated (undocumented)
export interface AnswersRequest extends SearchRequest {
}

// @public @deprecated (undocumented)
export const answersUtilities: typeof searchUtilities;

Expand Down Expand Up @@ -68,6 +91,10 @@ export interface AutocompleteService {
verticalAutocomplete(request: VerticalAutocompleteRequest): Promise<AutocompleteResponse>;
}

// @public @deprecated (undocumented)
export interface BaseAnswersConfig extends BaseSearchConfig {
}

// @public
export interface BaseSearchConfig {
endpoints?: Endpoints;
Expand Down

0 comments on commit 364f8cd

Please sign in to comment.