Library API Design

Library API Design Guide

Core Principles

1. Simplicity first (Simple > Clever)
2. Maintain consistency
3. Tree-shaking friendly
4. Maximize TypeScript inference
5. Ensure SSR safety

Core Patterns

Hook Return Values

// Single value
function useDebounce<T>(value: T, delay: number): T;

// Tuple (state + action)
function useToggle(init = false): [boolean, () => void];

// Object (3 or more fields)
function usePagination(): { page; nextPage; prevPage };

Parameters

// Required first, optional last
function useDebounce<T>(
  value: T,           // required
  delay: number,      // required
  options?: {...}     // optional
): T

SSR Safety

// ✅ SSR-safe
export function useMediaQuery(query: string): boolean {
  const [matches, setMatches] = useState(() => {
    if (typeof window === 'undefined') return false;
    return window.matchMedia(query).matches;
  });
}

Export

// ✅ Named exports only
export { useDebounce } from './useDebounce';

// ❌ Default export
export default useDebounce;

References

• details.md - Component design, advanced patterns