-
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.
Automated update to repo's documentation from github action
- Loading branch information
1 parent
dfae40a
commit 0d4fecf
Showing
24 changed files
with
335 additions
and
3 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) > [DayHour](./search-core.dayhour.md) > [isClosed](./search-core.dayhour.isclosed.md) | ||
|
||
## DayHour.isClosed property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
isClosed?: boolean; | ||
``` |
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) > [DayHour](./search-core.dayhour.md) | ||
|
||
## DayHour interface | ||
|
||
An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface DayHour | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [isClosed?](./search-core.dayhour.isclosed.md) | boolean | <i>(Optional)</i> | | ||
| [openIntervals?](./search-core.dayhour.openintervals.md) | [Interval](./search-core.interval.md)<!-- -->\[\] | <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) > [DayHour](./search-core.dayhour.md) > [openIntervals](./search-core.dayhour.openintervals.md) | ||
|
||
## DayHour.openIntervals property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
openIntervals?: Interval[]; | ||
``` |
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) > [HolidayHours](./search-core.holidayhours.md) > [date](./search-core.holidayhours.date.md) | ||
|
||
## HolidayHours.date property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
date: 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) > [HolidayHours](./search-core.holidayhours.md) > [isClosed](./search-core.holidayhours.isclosed.md) | ||
|
||
## HolidayHours.isClosed property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
isClosed?: boolean; | ||
``` |
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) > [HolidayHours](./search-core.holidayhours.md) > [isRegularHours](./search-core.holidayhours.isregularhours.md) | ||
|
||
## HolidayHours.isRegularHours property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
isRegularHours?: boolean; | ||
``` |
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,23 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-core](./search-core.md) > [HolidayHours](./search-core.holidayhours.md) | ||
|
||
## HolidayHours interface | ||
|
||
An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface HolidayHours | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [date](./search-core.holidayhours.date.md) | string | | | ||
| [isClosed?](./search-core.holidayhours.isclosed.md) | boolean | <i>(Optional)</i> | | ||
| [isRegularHours?](./search-core.holidayhours.isregularhours.md) | boolean | <i>(Optional)</i> | | ||
| [openIntervals?](./search-core.holidayhours.openintervals.md) | [Interval](./search-core.interval.md)<!-- -->\[\] | <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) > [HolidayHours](./search-core.holidayhours.md) > [openIntervals](./search-core.holidayhours.openintervals.md) | ||
|
||
## HolidayHours.openIntervals property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
openIntervals?: Interval[]; | ||
``` |
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) > [Hours](./search-core.hours.md) > [friday](./search-core.hours.friday.md) | ||
|
||
## Hours.friday property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
friday?: DayHour; | ||
``` |
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) > [Hours](./search-core.hours.md) > [holidayHours](./search-core.hours.holidayhours.md) | ||
|
||
## Hours.holidayHours property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
holidayHours?: HolidayHours[]; | ||
``` |
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) > [Hours](./search-core.hours.md) | ||
|
||
## Hours interface | ||
|
||
An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface Hours | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [friday?](./search-core.hours.friday.md) | [DayHour](./search-core.dayhour.md) | <i>(Optional)</i> | | ||
| [holidayHours?](./search-core.hours.holidayhours.md) | [HolidayHours](./search-core.holidayhours.md)<!-- -->\[\] | <i>(Optional)</i> | | ||
| [monday?](./search-core.hours.monday.md) | [DayHour](./search-core.dayhour.md) | <i>(Optional)</i> | | ||
| [reopenDate?](./search-core.hours.reopendate.md) | string | <i>(Optional)</i> | | ||
| [saturday?](./search-core.hours.saturday.md) | [DayHour](./search-core.dayhour.md) | <i>(Optional)</i> | | ||
| [sunday?](./search-core.hours.sunday.md) | [DayHour](./search-core.dayhour.md) | <i>(Optional)</i> | | ||
| [thursday?](./search-core.hours.thursday.md) | [DayHour](./search-core.dayhour.md) | <i>(Optional)</i> | | ||
| [tuesday?](./search-core.hours.tuesday.md) | [DayHour](./search-core.dayhour.md) | <i>(Optional)</i> | | ||
| [wednesday?](./search-core.hours.wednesday.md) | [DayHour](./search-core.dayhour.md) | <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) > [Hours](./search-core.hours.md) > [monday](./search-core.hours.monday.md) | ||
|
||
## Hours.monday property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
monday?: DayHour; | ||
``` |
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) > [Hours](./search-core.hours.md) > [reopenDate](./search-core.hours.reopendate.md) | ||
|
||
## Hours.reopenDate property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
reopenDate?: 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) > [Hours](./search-core.hours.md) > [saturday](./search-core.hours.saturday.md) | ||
|
||
## Hours.saturday property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
saturday?: DayHour; | ||
``` |
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) > [Hours](./search-core.hours.md) > [sunday](./search-core.hours.sunday.md) | ||
|
||
## Hours.sunday property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
sunday?: DayHour; | ||
``` |
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) > [Hours](./search-core.hours.md) > [thursday](./search-core.hours.thursday.md) | ||
|
||
## Hours.thursday property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
thursday?: DayHour; | ||
``` |
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) > [Hours](./search-core.hours.md) > [tuesday](./search-core.hours.tuesday.md) | ||
|
||
## Hours.tuesday property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
tuesday?: DayHour; | ||
``` |
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) > [Hours](./search-core.hours.md) > [wednesday](./search-core.hours.wednesday.md) | ||
|
||
## Hours.wednesday property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
wednesday?: DayHour; | ||
``` |
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-core](./search-core.md) > [Interval](./search-core.interval.md) > [end](./search-core.interval.end.md) | ||
|
||
## Interval.end property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
end?: 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,21 @@ | ||
<!-- Do not edit this file. It is automatically generated by API Documenter. --> | ||
|
||
[Home](./index.md) > [@yext/search-core](./search-core.md) > [Interval](./search-core.interval.md) | ||
|
||
## Interval interface | ||
|
||
An interface for hours fields to use in [BaseFieldValueDirectAnswer.value](./search-core.basefieldvaluedirectanswer.value.md)<!-- -->. | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
export interface Interval | ||
``` | ||
|
||
## Properties | ||
|
||
| Property | Type | Description | | ||
| --- | --- | --- | | ||
| [end?](./search-core.interval.end.md) | string | <i>(Optional)</i> | | ||
| [start?](./search-core.interval.start.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) > [Interval](./search-core.interval.md) > [start](./search-core.interval.start.md) | ||
|
||
## Interval.start property | ||
|
||
<b>Signature:</b> | ||
|
||
```typescript | ||
start?: 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
Oops, something went wrong.