@coveo/relay-event-types 6.24.2 → 6.26.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +26 -0
- package/package.json +1 -1
- package/relay-event-types.d.ts +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# Coveo Relay Event Types
|
|
2
|
+
|
|
3
|
+
This package contains automatically generated TypeScript types for Coveo's Event Protocol, and is intended to be used in conjunction with the Relay client side package.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Install using `npm install @coveo/relay-event-types`
|
|
8
|
+
|
|
9
|
+
## Usage
|
|
10
|
+
|
|
11
|
+
Import desired event type, e.g. for an `itemClick` event:
|
|
12
|
+
|
|
13
|
+
```
|
|
14
|
+
import { ItemClick } from "@coveo/relay-event-types";
|
|
15
|
+
|
|
16
|
+
const myClickEvent:ItemClick = {
|
|
17
|
+
searchUid: '2ce196c1-5859-42da-b051-63e77ae2b406',
|
|
18
|
+
position: 2,
|
|
19
|
+
itemMetadata: {
|
|
20
|
+
uniqueFieldName: 'permanentid',
|
|
21
|
+
uniqueFieldValue: 'XDSC-566782'
|
|
22
|
+
}
|
|
23
|
+
}
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
|
package/package.json
CHANGED
package/relay-event-types.d.ts
CHANGED
|
@@ -36,7 +36,7 @@ export interface EcCartAction extends Base {
|
|
|
36
36
|
*/
|
|
37
37
|
export interface EcProductClick extends Base {
|
|
38
38
|
/**
|
|
39
|
-
* Indicates the product's position using a 1-based index.
|
|
39
|
+
* Indicates the product's position using a 1-based index. Maximum possible value is 32767.
|
|
40
40
|
*/
|
|
41
41
|
position: number;
|
|
42
42
|
/**
|