Skip to content

Commit

Permalink
Remove Reference to provideCore in Doc
Browse files Browse the repository at this point in the history
This PR removes the reference to provideCore in the doc since it is not re-exported in headless and was causing an issue.
It also bumps the beta version to 2.3.0-beta.1.

J=BACK-2270
TEST=auto

Ran tests under tests/.

Change-Id: I906f8c1f5afd9ae18461e44dd222e6e4169c9e31
  • Loading branch information
EmilyZhang777 committed May 4, 2023
1 parent 508683b commit 7f08112
Show file tree
Hide file tree
Showing 11 changed files with 12 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/search-core.context.md
Expand Up @@ -9,7 +9,7 @@ Used to trigger Search [Query Rules](https://hitchhikers.yext.com/tracks/answers
<b>Signature:</b>

```typescript
export declare type Context = any;
export type Context = any;
```

## Remarks
Expand Down
2 changes: 1 addition & 1 deletion docs/search-core.enumorliteral.md
Expand Up @@ -9,5 +9,5 @@ Produces a union type from the enum passed as a generic which consists of the en
<b>Signature:</b>

```typescript
export declare type EnumOrLiteral<T extends string> = T | `${T}`;
export type EnumOrLiteral<T extends string> = T | `${T}`;
```
2 changes: 1 addition & 1 deletion docs/search-core.featuredsnippetdirectanswer.md
Expand Up @@ -9,7 +9,7 @@ All possible built-in [BaseFeaturedSnippetDirectAnswer](./search-core.basefeatur
<b>Signature:</b>

```typescript
export declare type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer;
export type FeaturedSnippetDirectAnswer = MultiLineTextSnippetDirectAnswer | RichTextSnippetDirectAnswer;
```
<b>References:</b> [MultiLineTextSnippetDirectAnswer](./search-core.multilinetextsnippetdirectanswer.md)<!-- -->, [RichTextSnippetDirectAnswer](./search-core.richtextsnippetdirectanswer.md)

2 changes: 1 addition & 1 deletion docs/search-core.fieldvaluedirectanswer.md
Expand Up @@ -9,7 +9,7 @@ Possible built-in and custom [BaseFieldValueDirectAnswer](./search-core.basefiel
<b>Signature:</b>

```typescript
export declare type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer | PhoneDirectAnswer | EmailDirectAnswer | AddressDirectAnswer | HoursDirectAnswer;
export type FieldValueDirectAnswer = UnknownFieldValueDirectAnswer | TextDirectAnswer | UrlDirectAnswer | RichTextDirectAnswer | DecimalDirectAnswer | FacebookUrlDirectAnswer | InstagramHandleDirectAnswer | TwitterHandleDirectAnswer | IosAppUrlDirectAnswer | AndroidAppUrlDirectAnswer | ComplexUrlDirectAnswer | IntegerDirectAnswer | PhoneDirectAnswer | EmailDirectAnswer | AddressDirectAnswer | HoursDirectAnswer;
```
<b>References:</b> [UnknownFieldValueDirectAnswer](./search-core.unknownfieldvaluedirectanswer.md)<!-- -->, [TextDirectAnswer](./search-core.textdirectanswer.md)<!-- -->, [UrlDirectAnswer](./search-core.urldirectanswer.md)<!-- -->, [RichTextDirectAnswer](./search-core.richtextdirectanswer.md)<!-- -->, [DecimalDirectAnswer](./search-core.decimaldirectanswer.md)<!-- -->, [FacebookUrlDirectAnswer](./search-core.facebookurldirectanswer.md)<!-- -->, [InstagramHandleDirectAnswer](./search-core.instagramhandledirectanswer.md)<!-- -->, [TwitterHandleDirectAnswer](./search-core.twitterhandledirectanswer.md)<!-- -->, [IosAppUrlDirectAnswer](./search-core.iosappurldirectanswer.md)<!-- -->, [AndroidAppUrlDirectAnswer](./search-core.androidappurldirectanswer.md)<!-- -->, [ComplexUrlDirectAnswer](./search-core.complexurldirectanswer.md)<!-- -->, [IntegerDirectAnswer](./search-core.integerdirectanswer.md)<!-- -->, [PhoneDirectAnswer](./search-core.phonedirectanswer.md)<!-- -->, [EmailDirectAnswer](./search-core.emaildirectanswer.md)<!-- -->, [AddressDirectAnswer](./search-core.addressdirectanswer.md)<!-- -->, [HoursDirectAnswer](./search-core.hoursdirectanswer.md)

2 changes: 1 addition & 1 deletion docs/search-core.highlightedfields.md
Expand Up @@ -9,7 +9,7 @@ A mapping of fields to the values emphasized by the Search API.
<b>Signature:</b>

```typescript
export declare type HighlightedFields = {
export type HighlightedFields = {
[fieldId: string]: HighlightedValue | HighlightedValue[] | HighlightedFields | HighlightedFields[];
};
```
Expand Down
2 changes: 1 addition & 1 deletion docs/search-core.sandboxendpoints.md
Expand Up @@ -6,7 +6,7 @@

> Warning: This API is now obsolete.
>
> Use [provideCore()](./search-core.providecore.md) with the appropriate [ServingConfig](./search-core.servingconfig.md) instead
> Set the appropriate environment and cloud region in [ServingConfig](./search-core.servingconfig.md) instead.
>
The endpoints to use for sandbox experiences.
Expand Down
2 changes: 1 addition & 1 deletion docs/search-core.searchconfig.md
Expand Up @@ -9,7 +9,7 @@ The main configuration options for [SearchCore](./search-core.searchcore.md)<!--
<b>Signature:</b>

```typescript
export declare type SearchConfig = SearchConfigWithApiKey | SearchConfigWithToken;
export type SearchConfig = SearchConfigWithApiKey | SearchConfigWithToken;
```
<b>References:</b> [SearchConfigWithApiKey](./search-core.searchconfigwithapikey.md)<!-- -->, [SearchConfigWithToken](./search-core.searchconfigwithtoken.md)

2 changes: 1 addition & 1 deletion docs/search-core.staticfilter.md
Expand Up @@ -9,7 +9,7 @@ Represents a static filter that will be used to refine results.
<b>Signature:</b>

```typescript
export declare type StaticFilter = FieldValueStaticFilter | DisjunctionStaticFilter | ConjunctionStaticFilter;
export type StaticFilter = FieldValueStaticFilter | DisjunctionStaticFilter | ConjunctionStaticFilter;
```
<b>References:</b> [FieldValueStaticFilter](./search-core.fieldvaluestaticfilter.md)<!-- -->, [DisjunctionStaticFilter](./search-core.disjunctionstaticfilter.md)<!-- -->, [ConjunctionStaticFilter](./search-core.conjunctionstaticfilter.md)

4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
@@ -1,6 +1,6 @@
{
"name": "@yext/search-core",
"version": "2.3.0-beta.0",
"version": "2.3.0-beta.1",
"description": "Typescript Networking Library for the Yext Search API",
"main": "./dist/commonjs/src/index.js",
"module": "./dist/esm/src/index.js",
Expand Down
2 changes: 1 addition & 1 deletion src/provideEndpoints.ts
Expand Up @@ -41,7 +41,7 @@ export class EndpointsFactory {
/**
* The endpoints to use for sandbox experiences.
*
* @deprecated Use {@link provideCore} with the appropriate {@link ServingConfig} instead
* @deprecated Set the appropriate environment and cloud region in {@link ServingConfig} instead.
*
* @public
*/
Expand Down

0 comments on commit 7f08112

Please sign in to comment.