-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
## Version 2.0.0 ### Breaking Changes - Re-exported all modified and newly added direct answer related interfaces from search-core V2. (#131 #133 #136 ) - More details of the changes are listed in [search-core v2 release notes](https://github.com/yext/search-core/releases/tag/v2.0.0) - Restructured static filters state to allow user to store more complex combination of static filters as well as field value filters. `SelectableFilter` interface is replaced with `SelectableStaticFilter`, which uses the new `StaticFilter` interface from search-core V2. The static filters state now accepts an array of `SelectableStaticFilter`. (#130 ) - All exports marked as `@deprecated` in previous version(s) as part of a rebranding process is now removed in V2 (#132 ) - for more details, the removed deprecated identifiers are listed in [v1.3 release notes](https://github.com/yext/search-headless/releases/tag/v1.3.0)
- Loading branch information
Showing
203 changed files
with
2,863 additions
and
1,180 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Address](./search-headless.address.md) > [city](./search-headless.address.city.md) | ||
|
||
## Address.city property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
city?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Address](./search-headless.address.md) > [countryCode](./search-headless.address.countrycode.md) | ||
|
||
## Address.countryCode property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
countryCode: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Address](./search-headless.address.md) > [extraDescription](./search-headless.address.extradescription.md) | ||
|
||
## Address.extraDescription property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
extraDescription?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Address](./search-headless.address.md) > [line1](./search-headless.address.line1.md) | ||
|
||
## Address.line1 property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
line1?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Address](./search-headless.address.md) > [line2](./search-headless.address.line2.md) | ||
|
||
## Address.line2 property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
line2?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Address](./search-headless.address.md) > [line3](./search-headless.address.line3.md) | ||
|
||
## Address.line3 property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
line3?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Address](./search-headless.address.md) | ||
|
||
## Address interface | ||
|
||
An interface with address fields to use in [BaseFieldValueDirectAnswer.value](./search-headless.basefieldvaluedirectanswer.value.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare interface Address | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [city?](./search-headless.address.city.md) | string | <i>(Optional)</i> | | ||
| [countryCode](./search-headless.address.countrycode.md) | string | | | ||
| [extraDescription?](./search-headless.address.extradescription.md) | string | <i>(Optional)</i> | | ||
| [line1?](./search-headless.address.line1.md) | string | <i>(Optional)</i> | | ||
| [line2?](./search-headless.address.line2.md) | string | <i>(Optional)</i> | | ||
| [line3?](./search-headless.address.line3.md) | string | <i>(Optional)</i> | | ||
| [postalCode?](./search-headless.address.postalcode.md) | string | <i>(Optional)</i> | | ||
| [region?](./search-headless.address.region.md) | string | <i>(Optional)</i> | | ||
| [sublocality?](./search-headless.address.sublocality.md) | string | <i>(Optional)</i> | | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Address](./search-headless.address.md) > [postalCode](./search-headless.address.postalcode.md) | ||
|
||
## Address.postalCode property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
postalCode?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Address](./search-headless.address.md) > [region](./search-headless.address.region.md) | ||
|
||
## Address.region property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
region?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [Address](./search-headless.address.md) > [sublocality](./search-headless.address.sublocality.md) | ||
|
||
## Address.sublocality property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
sublocality?: string; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AddressDirectAnswer](./search-headless.addressdirectanswer.md) > [fieldType](./search-headless.addressdirectanswer.fieldtype.md) | ||
|
||
## AddressDirectAnswer.fieldType property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fieldType: EnumOrLiteral<BuiltInFieldType.Address>; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AddressDirectAnswer](./search-headless.addressdirectanswer.md) | ||
|
||
## AddressDirectAnswer interface | ||
|
||
A [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md) interface with 'address' field type. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare interface AddressDirectAnswer extends BaseFieldValueDirectAnswer<Address> | ||
``` | ||
<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<!-- --><[Address](./search-headless.address.md)<!-- -->> | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [fieldType](./search-headless.addressdirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<!-- --><[BuiltInFieldType.Address](./search-headless.builtinfieldtype.md)<!-- -->> | | | ||
11 changes: 11 additions & 0 deletions
11
docs/search-headless.androidappurldirectanswer.fieldtype.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,11 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AndroidAppUrlDirectAnswer](./search-headless.androidappurldirectanswer.md) > [fieldType](./search-headless.androidappurldirectanswer.fieldtype.md) | ||
|
||
## AndroidAppUrlDirectAnswer.fieldType property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fieldType: EnumOrLiteral<BuiltInFieldType.AndroidAppURL>; | ||
``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-headless](./search-headless.md) > [AndroidAppUrlDirectAnswer](./search-headless.androidappurldirectanswer.md) | ||
|
||
## AndroidAppUrlDirectAnswer interface | ||
|
||
A direct answer for an android app url field. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export declare interface AndroidAppUrlDirectAnswer extends BaseFieldValueDirectAnswer<string> | ||
``` | ||
<b>Extends:</b> [BaseFieldValueDirectAnswer](./search-headless.basefieldvaluedirectanswer.md)<!-- --><string> | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [fieldType](./search-headless.androidappurldirectanswer.fieldtype.md) | [EnumOrLiteral](./search-headless.enumorliteral.md)<!-- --><[BuiltInFieldType.AndroidAppURL](./search-headless.builtinfieldtype.md)<!-- -->> | | | ||
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.