Skip to main content

Types & Interfaces

Cruxstack Node SDK is fully typed for TypeScript users. Here are the main types:

InitConfig​

interface InitConfig {
  clientId: string;
}
  • clientId: Your client identifier (required)

ExtendedEventData​

interface ExtendedEventData {
  // Identity & timing
  userId?: string;
  eventTime?: number;

  // Tenant context (per event)
  customerId?: string;
  customerName?: string;

  // Session
  sessionId?: string;

  // Browser/device
  userAgent?: string;
  screenHeight?: number;
  screenWidth?: number;
  language?: string;
  platform?: string;
  adBlock?: boolean;
  viewportHeight?: number;
  viewportWidth?: number;

  // Page
  pageTitle?: string;
  pageUrl?: string;
  pagePath?: string;
  pageDomain?: string;
  pageLoadTime?: number;
  referrer?: string;

  // Network
  ipAddress?: string;

  // Custom fields
  [key: string]: any;
}
  • All fields are optional; include what you have for each event.

GetUserTraitsResponse​

type GetUserTraitsResponse = {
  success: boolean;
  data?: any;
  message?: string;
  error?: string;
}