Skip to content

Commit

Permalink
Update Documentation (#20)
Browse files Browse the repository at this point in the history 
Add documentation for all parts of the public interface which were missing documentation

Also rename EnumOrLiteral to EnumOrString because I believe it's a little clearer

J=SLAP-1944
TEST=none

Visually inspect documentation on GitHub
  • Loading branch information
@cea2aj
cea2aj committed Mar 14, 2022
1 parent 1dea90a commit 2369ea9
Show file tree
Hide file tree
Showing 65 changed files with 276 additions and 172 deletions.
4 changes: 2 additions & 2 deletions docs/analytics.accordiontoggleevent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## AccordionToggleEvent interface

Event for expanding or collapsing an accordion row.
Event for expanding or collapsing an accordion row. Commonly used for FAQs.

<b>Signature:</b>

Expand All @@ -19,6 +19,6 @@ export interface AccordionToggleEvent
| [entityId](./analytics.accordiontoggleevent.entityid.md) | string | The entity ID for the entity. |
| [queryId](./analytics.accordiontoggleevent.queryid.md) | string | The ID of the most recent query. |
| [searcher?](./analytics.accordiontoggleevent.searcher.md) | [Searcher](./analytics.searcher.md) | <i>(Optional)</i> Whether it was on universal or vertical search. |
| [type](./analytics.accordiontoggleevent.type.md) | [EnumOrLiteral](./analytics.enumorliteral.md)<!-- -->&lt;[AnalyticsEventType.RowExpand](./analytics.analyticseventtype.md) \| [AnalyticsEventType.RowCollapse](./analytics.analyticseventtype.md)<!-- -->&gt; | |
| [type](./analytics.accordiontoggleevent.type.md) | [EnumOrString](./analytics.enumorstring.md)<!-- -->&lt;[AnalyticsEventType.RowExpand](./analytics.analyticseventtype.md) \| [AnalyticsEventType.RowCollapse](./analytics.analyticseventtype.md)<!-- -->&gt; | An enum member or its string value which denotes the event type. |
| [verticalKey](./analytics.accordiontoggleevent.verticalkey.md) | string | The vertical key for the vertical on which the event was fired. Or, if it is a universal search, the vertical key for the section in the universal results. |

4 changes: 3 additions & 1 deletion docs/analytics.accordiontoggleevent.type.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@

## AccordionToggleEvent.type property

An enum member or its string value which denotes the event type.

<b>Signature:</b>

```typescript
type: EnumOrLiteral<AnalyticsEventType.RowExpand | AnalyticsEventType.RowCollapse>;
type: EnumOrString<AnalyticsEventType.RowExpand | AnalyticsEventType.RowCollapse>;
```
2 changes: 1 addition & 1 deletion docs/analytics.alltabnavigationevent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,5 +17,5 @@ export interface AllTabNavigationEvent
| Property | Type | Description |
| --- | --- | --- |
| [queryId?](./analytics.alltabnavigationevent.queryid.md) | string | <i>(Optional)</i> The ID of the most recent query. |
| [type](./analytics.alltabnavigationevent.type.md) | [EnumOrLiteral](./analytics.enumorliteral.md)<!-- -->&lt;[AnalyticsEventType.AllTabNavigation](./analytics.analyticseventtype.md)<!-- -->&gt; | |
| [type](./analytics.alltabnavigationevent.type.md) | [EnumOrString](./analytics.enumorstring.md)<!-- -->&lt;[AnalyticsEventType.AllTabNavigation](./analytics.analyticseventtype.md)<!-- -->&gt; | An enum member or its string value which denotes the event type. |

4 changes: 3 additions & 1 deletion docs/analytics.alltabnavigationevent.type.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@

## AllTabNavigationEvent.type property

An enum member or its string value which denotes the event type.

<b>Signature:</b>

```typescript
type: EnumOrLiteral<AnalyticsEventType.AllTabNavigation>;
type: EnumOrString<AnalyticsEventType.AllTabNavigation>;
```
60 changes: 30 additions & 30 deletions docs/analytics.analyticseventtype.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,34 +16,34 @@ export declare enum AnalyticsEventType

| Member | Value | Description |
| --- | --- | --- |
| AddToCart | <code>&quot;ADD_TO_CART&quot;</code> | |
| AllTabNavigation | <code>&quot;ALL_TAB_NAVIGATION&quot;</code> | |
| ApplyNow | <code>&quot;APPLY_NOW&quot;</code> | |
| AutocompleteSelection | <code>&quot;AUTO_COMPLETE_SELECTION&quot;</code> | |
| BookAppointment | <code>&quot;BOOK_APPOINTMENT&quot;</code> | |
| CtaClick | <code>&quot;CTA_CLICK&quot;</code> | |
| DrivingDirections | <code>&quot;DRIVING_DIRECTIONS&quot;</code> | |
| Email | <code>&quot;EMAIL&quot;</code> | |
| FollowUpQuery | <code>&quot;FOLLOW_UP_QUERY&quot;</code> | |
| OrderNow | <code>&quot;ORDER_NOW&quot;</code> | |
| Paginate | <code>&quot;PAGINATE&quot;</code> | |
| QuestionFocus | <code>&quot;QUESTION_FOCUS&quot;</code> | |
| QuestionSubmit | <code>&quot;QUESTION_SUBMIT&quot;</code> | |
| ResultsHidden | <code>&quot;RESULTS_HIDDEN&quot;</code> | |
| ResultsUnhidden | <code>&quot;RESULTS_UNHIDDEN&quot;</code> | |
| RowCollapse | <code>&quot;ROW_COLLAPSE&quot;</code> | |
| RowExpand | <code>&quot;ROW_EXPAND&quot;</code> | |
| Rsvp | <code>&quot;RSVP&quot;</code> | |
| ScrollToBottomOfPage | <code>&quot;SCROLL_TO_BOTTOM_OF_PAGE&quot;</code> | |
| SearchBarImpression | <code>&quot;SEARCH_BAR_IMPRESSION&quot;</code> | |
| SearchClearButton | <code>&quot;SEARCH_CLEAR_BUTTON&quot;</code> | |
| TapToCall | <code>&quot;TAP_TO_CALL&quot;</code> | |
| ThumbsDown | <code>&quot;THUMBS_DOWN&quot;</code> | |
| ThumbsUp | <code>&quot;THUMBS_UP&quot;</code> | |
| TitleClick | <code>&quot;TITLE_CLICK&quot;</code> | |
| VerticalTabNavigation | <code>&quot;VERTICAL_TAB_NAVIGATION&quot;</code> | |
| VerticalViewAll | <code>&quot;VERTICAL_VIEW_ALL&quot;</code> | |
| ViewWebsite | <code>&quot;VIEW_WEBSITE&quot;</code> | |
| VoiceStart | <code>&quot;VOICE_START&quot;</code> | |
| VoiceStop | <code>&quot;VOICE_STOP&quot;</code> | |
| AddToCart | <code>&quot;ADD_TO_CART&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
| AllTabNavigation | <code>&quot;ALL_TAB_NAVIGATION&quot;</code> | [AllTabNavigationEvent](./analytics.alltabnavigationevent.md) |
| ApplyNow | <code>&quot;APPLY_NOW&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
| AutocompleteSelection | <code>&quot;AUTO_COMPLETE_SELECTION&quot;</code> | [AutocompleteEvent](./analytics.autocompleteevent.md) |
| BookAppointment | <code>&quot;BOOK_APPOINTMENT&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
| CtaClick | <code>&quot;CTA_CLICK&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
| DrivingDirections | <code>&quot;DRIVING_DIRECTIONS&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
| Email | <code>&quot;EMAIL&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
| FollowUpQuery | <code>&quot;FOLLOW_UP_QUERY&quot;</code> | [SearchDurationEvent](./analytics.searchdurationevent.md) |
| OrderNow | <code>&quot;ORDER_NOW&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
| Paginate | <code>&quot;PAGINATE&quot;</code> | [PaginationEvent](./analytics.paginationevent.md) |
| QuestionFocus | <code>&quot;QUESTION_FOCUS&quot;</code> | [QuestionSubmissionEvent](./analytics.questionsubmissionevent.md) |
| QuestionSubmit | <code>&quot;QUESTION_SUBMIT&quot;</code> | [QuestionSubmissionEvent](./analytics.questionsubmissionevent.md) |
| ResultsHidden | <code>&quot;RESULTS_HIDDEN&quot;</code> | [SearchDurationEvent](./analytics.searchdurationevent.md) |
| ResultsUnhidden | <code>&quot;RESULTS_UNHIDDEN&quot;</code> | [SearchDurationEvent](./analytics.searchdurationevent.md) |
| RowCollapse | <code>&quot;ROW_COLLAPSE&quot;</code> | [AccordionToggleEvent](./analytics.accordiontoggleevent.md) |
| RowExpand | <code>&quot;ROW_EXPAND&quot;</code> | [AccordionToggleEvent](./analytics.accordiontoggleevent.md) |
| Rsvp | <code>&quot;RSVP&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
| ScrollToBottomOfPage | <code>&quot;SCROLL_TO_BOTTOM_OF_PAGE&quot;</code> | [ScrollEvent](./analytics.scrollevent.md) |
| SearchBarImpression | <code>&quot;SEARCH_BAR_IMPRESSION&quot;</code> | [SearchBarImpressionEvent](./analytics.searchbarimpressionevent.md) |
| SearchClearButton | <code>&quot;SEARCH_CLEAR_BUTTON&quot;</code> | [SearchClearEvent](./analytics.searchclearevent.md) |
| TapToCall | <code>&quot;TAP_TO_CALL&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
| ThumbsDown | <code>&quot;THUMBS_DOWN&quot;</code> | [ThumbsFeedbackEvent](./analytics.thumbsfeedbackevent.md) |
| ThumbsUp | <code>&quot;THUMBS_UP&quot;</code> | [ThumbsFeedbackEvent](./analytics.thumbsfeedbackevent.md) |
| TitleClick | <code>&quot;TITLE_CLICK&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
| VerticalTabNavigation | <code>&quot;VERTICAL_TAB_NAVIGATION&quot;</code> | [AllTabNavigationEvent](./analytics.alltabnavigationevent.md) |
| VerticalViewAll | <code>&quot;VERTICAL_VIEW_ALL&quot;</code> | [VerticalViewAllEvent](./analytics.verticalviewallevent.md) |
| ViewWebsite | <code>&quot;VIEW_WEBSITE&quot;</code> | [CtaEvent](./analytics.ctaevent.md) |
| VoiceStart | <code>&quot;VOICE_START&quot;</code> | [VoiceSearchEvent](./analytics.voicesearchevent.md) |
| VoiceStop | <code>&quot;VOICE_STOP&quot;</code> | [VoiceSearchEvent](./analytics.voicesearchevent.md) |

6 changes: 3 additions & 3 deletions docs/analytics.analyticsresponse.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## AnalyticsResponse interface

Info about an analytics report response.
The response to the analytics report function.

<b>Signature:</b>

Expand All @@ -16,6 +16,6 @@ export interface AnalyticsResponse

| Property | Type | Description |
| --- | --- | --- |
| [message?](./analytics.analyticsresponse.message.md) | string | <i>(Optional)</i> |
| [status](./analytics.analyticsresponse.status.md) | 'success' \| 'error' | |
| [message?](./analytics.analyticsresponse.message.md) | string | <i>(Optional)</i> The message associated with the response. |
| [status](./analytics.analyticsresponse.status.md) | 'success' \| 'error' | Indicates whether or not the analytics report was sucessfully queued. |

2 changes: 2 additions & 0 deletions docs/analytics.analyticsresponse.message.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## AnalyticsResponse.message property

The message associated with the response.

<b>Signature:</b>

```typescript
Expand Down
7 changes: 7 additions & 0 deletions docs/analytics.analyticsresponse.status.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,15 @@

## AnalyticsResponse.status property

Indicates whether or not the analytics report was sucessfully queued.

<b>Signature:</b>

```typescript
status: 'success' | 'error';
```

## Remarks

The status will be accurate for all devices which support [Navigator.sendBeacon()](https://developer.mozilla.org/en-US/docs/Web/API/Navigator/sendBeacon)<!-- -->. If the analytics report is fired on Node.js, or IE11, the status will always return 'success'.

6 changes: 3 additions & 3 deletions docs/analytics.analyticsservice.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

## AnalyticsService interface

A service for Analytics.
A service for reporting analytics events.

<b>Signature:</b>

Expand All @@ -16,6 +16,6 @@ export interface AnalyticsService

| Method | Description |
| --- | --- |
| [report(event, additionalRequestAttributes)](./analytics.analyticsservice.report.md) | |
| [setVisitor(visitor)](./analytics.analyticsservice.setvisitor.md) | |
| [report(event, additionalRequestAttributes)](./analytics.analyticsservice.report.md) | Reports an analytics event. |
| [setVisitor(visitor)](./analytics.analyticsservice.setvisitor.md) | Sets the [Visitor](./analytics.visitor.md) object which is included with each subsequent request. |

6 changes: 4 additions & 2 deletions docs/analytics.analyticsservice.report.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## AnalyticsService.report() method

Reports an analytics event.

<b>Signature:</b>

```typescript
Expand All @@ -14,8 +16,8 @@ report(event: AnalyticsEvent, additionalRequestAttributes?: BeaconPayload): Anal

| Parameter | Type | Description |
| --- | --- | --- |
| event | [AnalyticsEvent](./analytics.analyticsevent.md) | |
| additionalRequestAttributes | [BeaconPayload](./analytics.beaconpayload.md) | |
| event | [AnalyticsEvent](./analytics.analyticsevent.md) | The [AnalyticsEvent](./analytics.analyticsevent.md) to be sent. |
| additionalRequestAttributes | [BeaconPayload](./analytics.beaconpayload.md) | Additional data included in the network request. |

<b>Returns:</b>

Expand Down
4 changes: 3 additions & 1 deletion docs/analytics.analyticsservice.setvisitor.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@

## AnalyticsService.setVisitor() method

Sets the [Visitor](./analytics.visitor.md) object which is included with each subsequent request.

<b>Signature:</b>

```typescript
Expand All @@ -14,7 +16,7 @@ setVisitor(visitor: Visitor | undefined): void;

| Parameter | Type | Description |
| --- | --- | --- |
| visitor | [Visitor](./analytics.visitor.md) \| undefined | |
| visitor | [Visitor](./analytics.visitor.md) \| undefined | The visitor to be set, or undefined. |

<b>Returns:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/analytics.autocompleteevent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ export interface AutocompleteEvent
| --- | --- | --- |
| [queryId?](./analytics.autocompleteevent.queryid.md) | string | <i>(Optional)</i> The ID of the most recent query. |
| [suggestedSearchText](./analytics.autocompleteevent.suggestedsearchtext.md) | string | Selected search text from an autocomplete suggestion. |
| [type](./analytics.autocompleteevent.type.md) | [EnumOrLiteral](./analytics.enumorliteral.md)<!-- -->&lt;[AnalyticsEventType.AutocompleteSelection](./analytics.analyticseventtype.md)<!-- -->&gt; | |
| [type](./analytics.autocompleteevent.type.md) | [EnumOrString](./analytics.enumorstring.md)<!-- -->&lt;[AnalyticsEventType.AutocompleteSelection](./analytics.analyticseventtype.md)<!-- -->&gt; | An enum member or its string value which denotes the event type. |

4 changes: 3 additions & 1 deletion docs/analytics.autocompleteevent.type.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@

## AutocompleteEvent.type property

An enum member or its string value which denotes the event type.

<b>Signature:</b>

```typescript
type: EnumOrLiteral<AnalyticsEventType.AutocompleteSelection>;
type: EnumOrString<AnalyticsEventType.AutocompleteSelection>;
```
1 change: 1 addition & 0 deletions docs/analytics.beaconpayload.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

## BeaconPayload interface

The shape of the data which is sent during a beacon request.

<b>Signature:</b>

Expand Down
2 changes: 1 addition & 1 deletion docs/analytics.ctaevent.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ export interface CtaEvent
| [fieldName?](./analytics.ctaevent.fieldname.md) | string | <i>(Optional)</i> The name of the Rich Text field used. |
| [queryId](./analytics.ctaevent.queryid.md) | string | The ID of the most recent query. |
| [searcher](./analytics.ctaevent.searcher.md) | [Searcher](./analytics.searcher.md) | Whether it was on universal or vertical search. |
| [type](./analytics.ctaevent.type.md) | [EnumOrLiteral](./analytics.enumorliteral.md)<!-- -->&lt;[AnalyticsEventType.CtaClick](./analytics.analyticseventtype.md) \| [AnalyticsEventType.TitleClick](./analytics.analyticseventtype.md) \| [AnalyticsEventType.TapToCall](./analytics.analyticseventtype.md) \| [AnalyticsEventType.OrderNow](./analytics.analyticseventtype.md) \| [AnalyticsEventType.AddToCart](./analytics.analyticseventtype.md) \| [AnalyticsEventType.ApplyNow](./analytics.analyticseventtype.md) \| [AnalyticsEventType.DrivingDirections](./analytics.analyticseventtype.md) \| [AnalyticsEventType.ViewWebsite](./analytics.analyticseventtype.md) \| [AnalyticsEventType.Email](./analytics.analyticseventtype.md) \| [AnalyticsEventType.BookAppointment](./analytics.analyticseventtype.md) \| [AnalyticsEventType.Rsvp](./analytics.analyticseventtype.md)<!-- -->&gt; | |
| [type](./analytics.ctaevent.type.md) | [EnumOrString](./analytics.enumorstring.md)<!-- -->&lt;[AnalyticsEventType.CtaClick](./analytics.analyticseventtype.md) \| [AnalyticsEventType.TitleClick](./analytics.analyticseventtype.md) \| [AnalyticsEventType.TapToCall](./analytics.analyticseventtype.md) \| [AnalyticsEventType.OrderNow](./analytics.analyticseventtype.md) \| [AnalyticsEventType.AddToCart](./analytics.analyticseventtype.md) \| [AnalyticsEventType.ApplyNow](./analytics.analyticseventtype.md) \| [AnalyticsEventType.DrivingDirections](./analytics.analyticseventtype.md) \| [AnalyticsEventType.ViewWebsite](./analytics.analyticseventtype.md) \| [AnalyticsEventType.Email](./analytics.analyticseventtype.md) \| [AnalyticsEventType.BookAppointment](./analytics.analyticseventtype.md) \| [AnalyticsEventType.Rsvp](./analytics.analyticseventtype.md)<!-- -->&gt; | An enum member or its string value which denotes the event type. |
| [url?](./analytics.ctaevent.url.md) | string | <i>(Optional)</i> The url of the event target. |
| [verticalKey](./analytics.ctaevent.verticalkey.md) | string | The vertical key for the vertical on which the event was fired. Or, if it is a universal search, the vertical key for the section in the universal results. |

4 changes: 3 additions & 1 deletion docs/analytics.ctaevent.type.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,10 @@

## CtaEvent.type property

An enum member or its string value which denotes the event type.

<b>Signature:</b>

```typescript
type: EnumOrLiteral<AnalyticsEventType.CtaClick | AnalyticsEventType.TitleClick | AnalyticsEventType.TapToCall | AnalyticsEventType.OrderNow | AnalyticsEventType.AddToCart | AnalyticsEventType.ApplyNow | AnalyticsEventType.DrivingDirections | AnalyticsEventType.ViewWebsite | AnalyticsEventType.Email | AnalyticsEventType.BookAppointment | AnalyticsEventType.Rsvp>;
type: EnumOrString<AnalyticsEventType.CtaClick | AnalyticsEventType.TitleClick | AnalyticsEventType.TapToCall | AnalyticsEventType.OrderNow | AnalyticsEventType.AddToCart | AnalyticsEventType.ApplyNow | AnalyticsEventType.DrivingDirections | AnalyticsEventType.ViewWebsite | AnalyticsEventType.Email | AnalyticsEventType.BookAppointment | AnalyticsEventType.Rsvp>;
```
12 changes: 0 additions & 12 deletions docs/analytics.enumorliteral.md
View file

This file was deleted.

18 changes: 18 additions & 0 deletions docs/analytics.enumorstring.md
View file
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/analytics](./analytics.md) &gt; [EnumOrString](./analytics.enumorstring.md)

## EnumOrString type

A TypeScript utility type which creates a union of an enum member and its string representation.

<b>Signature:</b>

```typescript
export declare type EnumOrString<T extends string> = T | `${T}`;
```

## Remarks

Allows interfaces to support both enums and strings.

12 changes: 6 additions & 6 deletions docs/analytics.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,17 @@

| Interface | Description |
| --- | --- |
| [AccordionToggleEvent](./analytics.accordiontoggleevent.md) | Event for expanding or collapsing an accordion row. |
| [AccordionToggleEvent](./analytics.accordiontoggleevent.md) | Event for expanding or collapsing an accordion row. Commonly used for FAQs. |
| [AllTabNavigationEvent](./analytics.alltabnavigationevent.md) | Event for navigating to the 'all' tab (a universal page). |
| [AnalyticsConfig](./analytics.analyticsconfig.md) | The main configuration options for Analytics. |
| [AnalyticsResponse](./analytics.analyticsresponse.md) | Info about an analytics report response. |
| [AnalyticsService](./analytics.analyticsservice.md) | A service for Analytics. |
| [AnalyticsResponse](./analytics.analyticsresponse.md) | The response to the analytics report function. |
| [AnalyticsService](./analytics.analyticsservice.md) | A service for reporting analytics events. |
| [AutocompleteEvent](./analytics.autocompleteevent.md) | Event for autocomplete selection. |
| [BeaconPayload](./analytics.beaconpayload.md) | |
| [BeaconPayload](./analytics.beaconpayload.md) | The shape of the data which is sent during a beacon request. |
| [CtaEvent](./analytics.ctaevent.md) | A call to action analytics event. |
| [PaginationEvent](./analytics.paginationevent.md) | Event for pagination interaction. |
| [QuestionSubmissionEvent](./analytics.questionsubmissionevent.md) | Event for submitting a question. |
| [ScrollEvent](./analytics.scrollevent.md) | |
| [ScrollEvent](./analytics.scrollevent.md) | Event for scrolling to the bottom of the page. |
| [SearchBarImpressionEvent](./analytics.searchbarimpressionevent.md) | Event for expanding or collapsing an accordion row. |
| [SearchClearEvent](./analytics.searchclearevent.md) | Event for clicking on the button to clear the search input. |
| [SearchDurationEvent](./analytics.searchdurationevent.md) | Event used to calculate the duration of a search. |
Expand All @@ -45,6 +45,6 @@
| Type Alias | Description |
| --- | --- |
| [AnalyticsEvent](./analytics.analyticsevent.md) | An analytics event. |
| [EnumOrLiteral](./analytics.enumorliteral.md) | |
| [EnumOrString](./analytics.enumorstring.md) | A TypeScript utility type which creates a union of an enum member and its string representation. |
| [Searcher](./analytics.searcher.md) | Whether the search occurred on universal or vertical search. |

Loading

0 comments on commit 2369ea9

Please sign in to comment.