roaarrr-browser/index.d.ts

Browser analytics tracking library for roaarrr

export interface UserData {
  identification: string;
  [key: string]: any;
}

export interface EventData {
  [key: string]: any;
}

export interface Analytics {
  /**
   * Initialize the analytics with an API key
   * @param apiKey - Your roaarrr API key
   * @param config - Optional configuration object
   */
  init(apiKey: string, config?: any): void;

  /**
   * Identify a user with optional user data
   * @param userData - User data object containing identification and other properties
   */
  identify(userData: UserData): void;

  /**
   * Track a funnel event
   * @param eventName - Name of the event to track
   * @param eventData - Optional event data
   */
  funnel(eventName: string, eventData?: EventData): void;
}

declare const analytics: Analytics;
export default analytics;
export { analytics };