AudienceRanker Client

A lightweight, zero-dependency client-side analytics tracking library for AudienceRanker.

Features

• 🚀 Tiny bundle size (<3KB gzipped)
• 📦 Multiple module formats (ESM, CJS, UMD)
• 🔧 TypeScript support with full type definitions

Installation

npm install @audienceranker/client

or

yarn add @audienceranker/client

or

bun i @audienceranker/client

Usage

Basic Usage

import Analytics from '@audienceranker/client';

// Initialize with your domain
const analytics = new Analytics('example.com');

// Track current page
analytics.track();

Custom Endpoint

const analytics = new Analytics('example.com', '/custom/analytics/endpoint');

Different Tracking Methods

// Track on page load
analytics.trackOnLoad();

// Track page views with visibility tracking
analytics.trackPageView();

Using Individual Functions

import { collectAnalyticsData, sendAnalytics } from '@audienceranker/client';

// Collect data manually
const data = collectAnalyticsData();
console.log(data);

// Send analytics with custom config
await sendAnalytics({
  domain: 'example.com',
  endpoint: '/log'
});

Browser Usage (UMD)

<script src="https://unpkg.com/@audienceranker/client/dist/index.umd.js"></script>
<script>
  const analytics = new WebAnalyticsClient.Analytics('example.com');
  analytics.track();
</script>

API Reference

Analytics Class

Constructor

new Analytics(domain: string, endpoint?: string)

• domain: Your website domain (required)
• endpoint: Analytics endpoint path (default: '/log')

Methods

• track(): Send analytics data immediately
• trackOnLoad(): Track when page loads
• trackPageView(): Track page views and visibility changes

Exported Functions

• collectAnalyticsData(): Returns current analytics data
• sendAnalytics(config): Send analytics with custom configuration