-
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.
- Loading branch information
Showing
16 changed files
with
218 additions
and
0 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
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-core](./search-core.md) > [Address](./search-core.address.md) > [city](./search-core.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-core](./search-core.md) > [Address](./search-core.address.md) > [countryCode](./search-core.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-core](./search-core.md) > [Address](./search-core.address.md) > [extraDescription](./search-core.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-core](./search-core.md) > [Address](./search-core.address.md) > [line1](./search-core.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-core](./search-core.md) > [Address](./search-core.address.md) > [line2](./search-core.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-core](./search-core.md) > [Address](./search-core.address.md) > [line3](./search-core.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-core](./search-core.md) > [Address](./search-core.address.md) | ||
|
||
## Address interface | ||
|
||
A type interface with address fields to use in [FieldValueDirectAnswer.value](./search-core.fieldvaluedirectanswer.value.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface Address | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [city?](./search-core.address.city.md) | string | <i>(Optional)</i> | | ||
| [countryCode?](./search-core.address.countrycode.md) | string | <i>(Optional)</i> | | ||
| [extraDescription?](./search-core.address.extradescription.md) | string | <i>(Optional)</i> | | ||
| [line1?](./search-core.address.line1.md) | string | <i>(Optional)</i> | | ||
| [line2?](./search-core.address.line2.md) | string | <i>(Optional)</i> | | ||
| [line3?](./search-core.address.line3.md) | string | <i>(Optional)</i> | | ||
| [postalCode?](./search-core.address.postalcode.md) | string | <i>(Optional)</i> | | ||
| [region?](./search-core.address.region.md) | string | <i>(Optional)</i> | | ||
| [sublocality?](./search-core.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-core](./search-core.md) > [Address](./search-core.address.md) > [postalCode](./search-core.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-core](./search-core.md) > [Address](./search-core.address.md) > [region](./search-core.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-core](./search-core.md) > [Address](./search-core.address.md) > [sublocality](./search-core.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-core](./search-core.md) > [AddressDirectAnswer](./search-core.addressdirectanswer.md) > [fieldType](./search-core.addressdirectanswer.fieldtype.md) | ||
|
||
## AddressDirectAnswer.fieldType property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
fieldType: 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-core](./search-core.md) > [AddressDirectAnswer](./search-core.addressdirectanswer.md) | ||
|
||
## AddressDirectAnswer interface | ||
|
||
A interface for direct answers [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md) with address values. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface AddressDirectAnswer extends FieldValueDirectAnswer<Address> | ||
``` | ||
<b>Extends:</b> [FieldValueDirectAnswer](./search-core.fieldvaluedirectanswer.md)<!-- --><[Address](./search-core.address.md)<!-- -->> | ||
## Properties | ||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [fieldType](./search-core.addressdirectanswer.fieldtype.md) | [BuiltInFieldType.Address](./search-core.builtinfieldtype.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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
import { FieldValueDirectAnswer } from "./FieldValueDirectAnswer"; | ||
import { BuiltInFieldType } from "./BuiltInFieldType"; | ||
|
||
/** | ||
* A interface for direct answers {@link FieldValueDirectAnswer} with address values. | ||
* | ||
* @public | ||
*/ | ||
export interface AddressDirectAnswer extends FieldValueDirectAnswer<Address> { | ||
fieldType: BuiltInFieldType.Address | ||
} | ||
|
||
/** | ||
* A type interface with address fields to use in {@link FieldValueDirectAnswer.value}. | ||
* | ||
* @public | ||
*/ | ||
export interface Address { | ||
line1?: string, | ||
line2?: string, | ||
line3?: string, | ||
sublocality?: string, | ||
city?: string, | ||
region?: string, | ||
postalCode?: string, | ||
extraDescription?: string, | ||
countryCode?: string, | ||
} |