@coveo/relay-event-types
TypeScript icon, indicating that this package has built-in type declarations

13.0.0 • Public • Published

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'
    }
}

Package Sidebar

Install

npm i @coveo/relay-event-types

Weekly Downloads

8,467

Version

13.0.0

License

Apache-2.0

Unpacked Size

17.3 kB

Total Files

3

Last publish

Collaborators

  • aboissinot
  • lcoolen
  • coveo-organization
  • coveoit
  • olamothe
  • sssayegh
  • ylakhdar
  • agong-coveo
  • ndlr
  • npmcoveo
  • jkatofsky
  • pixhel
  • mmitiche
  • nlegros
  • sallain
  • msrioux