@coveo/relay-event-types

Coveo Relay Event Types

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.

Installation

Install using npm install @coveo/relay-event-types

Usage

Import desired event type, e.g. for an itemClick event:

import { ItemClick } from "@coveo/relay-event-types";

const myClickEvent:ItemClick  = {
    searchUid: '2ce196c1-5859-42da-b051-63e77ae2b406',
    position: 2,
    itemMetadata: {
        uniqueFieldName: 'permanentid',
        uniqueFieldValue: 'XDSC-566782'
    }
}