TypeScript

type LynqProps = Record<string, string | number | boolean | null | undefined>;
 
interface Lynq {
  /** Record a custom event; properties are flat and stored as text. */
  track(name: string, properties?: LynqProps): void;
  /** Attach the session to one of your users; ignored under Global Privacy Control. */
  identify(userId: string): void;
  /** Report a handled error: an Error, a string or anything thrown. Ten per page load. */
  error(error: unknown): void;
  /** Put the session in an experiment: variants assigns, variant records yours, neither reads. */
  experiment(opts: {
    name: string;
    variants?: string[] | Record<string, number>;
    variant?: string;
  }): string | undefined;
  /** Stop measuring this browser (sets one localStorage flag). */
  optOut(): void;
  /** Measure this browser again. */
  optIn(): void;
}
 
declare global {
  interface Window {
    /** Present once the script has loaded. */
    lynq?: Lynq;
    /** Calls queued before the script loads are replayed on start. */
    lynqQueue?: { name: string; properties?: LynqProps }[];
  }
}
 
export {};