llms.txt
llms.txt

Reference

2 min read

A compact map of the main package exports and where to learn more.

Core exports

Export area What it covers
@farmjs/core Config, app types, plugins, integrations, routing, OpenAPI, docs, cache.
@farmjs/core/client Link, router helpers, API client, integration client.
@farmjs/core/plugin/client Advanced browser lifecycle manager and client plugin event types.
@farmjs/core/navigation Next-compatible redirect, notFound, and client navigation hooks.
@farmjs/core/headers Next-compatible request headers and cookies helpers.
@farmjs/core/router Lightweight route matching, href building, and active-route checks.
@farmjs/core/query Query and route param types.
@farmjs/core/storage Storage clients and mount helpers.
@farmjs/core/cache Data cache, revalidation, cache keys.
@farmjs/core/after Post-response server work with after().
@farmjs/core/cron Cron route authorization, schedule types, manifests, and deployment adapter helpers.
@farmjs/integrations Auth, billing, email, jobs, AI, API keys, provider clients.
  1. Start with Getting Started and Project Structure.
  2. Read Routing, Layouts, and Rendering Model.
  3. Add API Routes, API Client, and Query.
  4. Choose integrations and storage once your product needs them.
  5. Finish with Deployment, Observability, and Reference.

Integration exports

Package Exports
@farmjs/core defineIntegration, integrationRoute, defineIntegrationSchema, definePlugin, defineConfig.
@farmjs/core/cron cronRoute, cron config types, schedule manifests, and deployment adapter helpers.
@farmjs/core/workflows Legacy workflow-module APIs kept for compatibility. New schedules should use cron config and API routes.
@farmjs/core/client createIntegrations, createIntegrationClient, createIntegrationServerClient, endpoint.
@farmjs/core/plugin/client createClientPluginManager and browser lifecycle types for advanced tooling.
@farmjs/core/navigation redirect, permanentRedirect, notFound, useRouter, usePathname, useSearchParams.
@farmjs/core/headers headers, cookies.
@farmjs/core/router createFarmRouter, matchFarmRoute, buildFarmRoutePath, isFarmRouteActive.
@farmjs/core/storage sqliteStorage, postgresStorage, redisStorage, createStorageClient, defineStorageClient.
@farmjs/core/after after for short work that starts after the current response finishes.
@farmjs/integrations/stripe Stripe billing integration.
@farmjs/integrations/auth Better Auth, Auth.js, Clerk, Auth0, WorkOS helpers when using the auth barrel.
@farmjs/integrations/supabase Supabase auth integration.
@farmjs/integrations/email Resend integration and email template helper.
@farmjs/integrations/jobs Jobs integration, task, defineTasks, Trigger.dev runtime, Inngest runtime.
@farmjs/integrations/unkey Unkey API key integration.

Mental model

  • Pages and layouts are app UI.
  • API routes are app-owned HTTP handlers.
  • API clients are typed callers for app routes.
  • Integrations are provider or feature packages that can own routes, callers, schemas, providers, config, and lifecycle.
  • Plugins are framework-level hooks for server requests, rendering, builds, browser hydration, navigation, and runtime behavior.
  • Storage is the shared place to pass key/value stores and runtime database clients.
  • Cron maps a UTC schedule to an app-owned GET API route; it does not add durable workflow state.
Last updated at