API Reference

Packages

DataFn is organized into three packages:

@datafn/core

Shared types, schema validation, filter evaluation, normalization utilities, date conversion, KV helpers, and plugin hook execution. Used by both client and server.

• Core Types -- all type definitions
• Schema Utilities -- validation and indexing
• Filter Utilities -- filter evaluation and operators
• Normalization -- DFQL normalization for caching
• Date Utilities -- date format conversion
• KV Utilities -- built-in key-value resource
• Hook Utilities -- plugin hook execution
• Error Types -- error codes and envelopes

@datafn/client

Browser and Node.js client with offline support, sync engine, reactive signals, event bus, and storage adapters.

• Client Configuration -- createDatafnClient options
• Query Execution -- client query internals
• Mutation Execution -- client mutation internals
• Signal API -- reactive signal system
• Storage Adapter -- storage interface
• Sync Engine -- sync engine internals
• Event Bus -- event system
• Transport -- HTTP transport and remote adapter

@datafn/server

Node.js server with route handlers, execution engine, middleware, and WebSocket support.

• Server Configuration -- createDatafnServer options
• Route Handlers -- handler internals
• Middleware -- rate limiting and timing
• Execution Engine -- query and mutation execution
• WebSocket Manager -- real-time push