Remy Reference/interface/CustomEventProps

CustomEventProps

Type

The props accepted by `analytics.track`: a flat map of primitive values, capped in size.

A flat record of string, number, or boolean values, the shape analytics.track expects for its props. Nested objects, arrays, and null are dropped on the client before send, and the server caps the map at ten keys, keys at fifty characters, and values at five hundred.

CustomEventProps.ts

type CustomEventProps = Record<string, string | number | boolean>

A valid props map

analytics.track('vendor_submitted', {
  vendorType: 'restaurant', // string
  lineItems: 3,             // number
  expedited: true,          // boolean
});
// nested objects, arrays, and null are dropped before send