API Reference

Comprehensive documentation for all honolytics APIs, organized by functionality.

React Hooks API

React hooks for building analytics dashboards with caching, polling, and error handling.

• Core Hooks — useAnalytics, HonolyticsProvider, and useConfig
• Metric Slice Hooks — useTotals, useTimeseries, useTopPages, etc.
• Hook Types & Behaviors — THookResponse, caching, and polling behavior

Storage API

Storage adapters for persisting analytics data without external APIs.

• Local Storage — Browser localStorage adapter ✅ Production Ready
• IndexedDB — Browser IndexedDB adapter ✅ Production Ready
• PostgreSQL — PostgreSQL database adapter ⚠️ Needs Testing
• Turso — Turso SQLite adapter ⚠️ Needs Testing
• SQLite — SQLite adapter ❌ Not Implemented
• Storage Types & Interface — TAdapter, TEvent, and type definitions

Quick Reference

Basic Usage

import { HonolyticsProvider, useAnalytics } from 'honolytics'

// HTTP Mode
<HonolyticsProvider apiKey="key" endpoint="/api/metrics">
  <App />
</HonolyticsProvider>

// Storage Mode
<HonolyticsProvider storageMode={true}>
  <App />
</HonolyticsProvider>

// In components
const { data, loading, error, refetch } = useAnalytics()

Storage Setup

import { initStorage, local, postgres } from 'honolytics/storage'

// Browser storage
await initStorage(local())

// Database storage
await initStorage(postgres({ url: 'postgresql://...' }))

Implementation Status