API Reference

Complete TypeScript API documentation for Lager Guru.

Overview

This section contains automatically generated API documentation from TypeScript source code.

Sections

Note: Detailed API documentation is generated from TypeScript source code using TypeDoc. Run npm run docs:generate:api to generate the full documentation.

• Hooks - Custom React hooks
• Context Providers - React context providers
• Integrations - External service integrations
• Utilities - Utility functions and helpers

TypeDoc Documentation

Full TypeDoc documentation is generated from source code comments. Run:

npm run docs:generate:api

This will generate detailed API documentation in docs/api/ directory.

Hooks

Custom React hooks for authentication, branding, and data management.

Context Providers

React context providers for global state management.

Integrations

External service integrations including Supabase client setup.

Utilities

Utility functions and helpers for common operations.

Code Examples

Using Hooks

import { useAuth } from '@/contexts/AuthContext';
import { useBranding } from '@/contexts/BrandingContext';

function MyComponent() {
  const { user, userRole } = useAuth();
  const { branding } = useBranding();
  // ...
}

Using Utilities

import { cn } from '@/lib/utils';
import { suggestDriver } from '@/lib/ai';

const className = cn('base-class', condition && 'conditional-class');
const suggestion = suggestDriver(shipments, drivers);

Contributing

When adding new APIs:

1. Add JSDoc comments to your code
2. Include type definitions
3. Provide usage examples
4. Run npm run docs:generate:api to update documentation